Commerce Metrics

The AggregateMetric Object

Rutter performs various computations over your commerce data. The results of these computations are called aggregate metrics.

You can find the metrics we support, their corresponding metric name, and the formula used to compute them here.

Properties

start_datestringRequired

The starting date from which we start aggregating activity (revenue, expenses, etc).

end_datestringRequired

The date at which we stop aggregating activity (revenue, expenses, etc).

currencystringRequired

If applicable, the currency used for the value returned.

valuestringRequired

The value of the requested metric for the time range described by the start and end date.

Endpoints
GET
/commerce/metrics/:metricName

Fetch a Metric

GEThttps://production.rutterapi.com/versioned/commerce/metrics/:metricName

The object returned will use a key matching the value of the parameter "Metric Name". It will also have a connection and checkpoint key. All other keys will be undefined.

For example, if you send a request to '/metrics/commerce/total_revenue', you will receive an object with values for the keys "total_revenue", "connection", and "checkpoint", nothing else.

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    checkpointstringRequired

    The ISO 8601 timestamp for the date at which the metric was last updated.

    connectionobjectRequired
    Show connection attributes
    active_customersarray

    The metric value and important metadata that defines the method of calculation.

    Show active_customers attributes
    amortization_expensearray

    The metric value and important metadata that defines the method of calculation.

    Show amortization_expense attributes
    capital_expenditurearray

    The metric value and important metadata that defines the method of calculation.

    Show capital_expenditure attributes
    cash_flow_to_debt_ratioarray

    The metric value and important metadata that defines the method of calculation.

    Show cash_flow_to_debt_ratio attributes
    change_in_working_capitalarray

    The metric value and important metadata that defines the method of calculation.

    Show change_in_working_capital attributes
    cost_of_goods_soldarray

    The metric value and important metadata that defines the method of calculation.

    Show cost_of_goods_sold attributes
    current_assetsarray

    The metric value and important metadata that defines the method of calculation.

    Show current_assets attributes
    current_liabilitiesarray

    The metric value and important metadata that defines the method of calculation.

    Show current_liabilities attributes
    current_ratioarray

    The metric value and important metadata that defines the method of calculation.

    Show current_ratio attributes
    debt_servicearray

    The metric value and important metadata that defines the method of calculation.

    Show debt_service attributes
    debt_service_coverage_ratioarray

    The metric value and important metadata that defines the method of calculation.

    Show debt_service_coverage_ratio attributes
    debt_service_from_income_statementarray

    The metric value and important metadata that defines the method of calculation.

    Show debt_service_from_income_statement attributes
    debt_service_from_principal_paidarray

    The metric value and important metadata that defines the method of calculation.

    Show debt_service_from_principal_paid attributes
    debt_to_income_ratioarray

    The metric value and important metadata that defines the method of calculation.

    Show debt_to_income_ratio attributes
    depreciation_expensearray

    The metric value and important metadata that defines the method of calculation.

    Show depreciation_expense attributes
    ebitdaarray

    The metric value and important metadata that defines the method of calculation.

    Show ebitda attributes
    ebitda_marginarray

    The metric value and important metadata that defines the method of calculation.

    Show ebitda_margin attributes
    enterprise_free_cash_flowarray

    The metric value and important metadata that defines the method of calculation.

    Show enterprise_free_cash_flow attributes
    enterprise_free_cash_flow_formula_twoarray

    The metric value and important metadata that defines the method of calculation.

    Show enterprise_free_cash_flow_formula_two attributes
    gross_profit_marginarray

    The metric value and important metadata that defines the method of calculation.

    Show gross_profit_margin attributes
    interest_expensearray

    The metric value and important metadata that defines the method of calculation.

    Show interest_expense attributes
    inventoryarray

    The metric value and important metadata that defines the method of calculation.

    Show inventory attributes
    net_incomearray

    The metric value and important metadata that defines the method of calculation.

    Show net_income attributes
    net_operating_incomearray

    The metric value and important metadata that defines the method of calculation.

    Show net_operating_income attributes
    net_profit_marginarray

    The metric value and important metadata that defines the method of calculation.

    Show net_profit_margin attributes
    prepaid_expensesarray

    The metric value and important metadata that defines the method of calculation.

    Show prepaid_expenses attributes
    principal_paidarray

    The metric value and important metadata that defines the method of calculation.

    Show principal_paid attributes
    quick_ratioarray

    The metric value and important metadata that defines the method of calculation.

    Show quick_ratio attributes
    refund_ratearray

    The metric value and important metadata that defines the method of calculation.

    Show refund_rate attributes
    rental_expensearray

    The metric value and important metadata that defines the method of calculation.

    Show rental_expense attributes
    total_expensesarray

    The metric value and important metadata that defines the method of calculation.

    Show total_expenses attributes
    total_incomearray

    The metric value and important metadata that defines the method of calculation.

    Show total_income attributes
    total_ordersarray

    The metric value and important metadata that defines the method of calculation.

    Show total_orders attributes
    total_revenuearray

    The metric value and important metadata that defines the method of calculation.

    Show total_revenue attributes
    unearned_revenuesarray

    The metric value and important metadata that defines the method of calculation.

    Show unearned_revenues attributes
    working_capitalarray

    The metric value and important metadata that defines the method of calculation.

    Show working_capital attributes
Support by integration
  • Shopify
    Shopify
  • Amazon
    Amazon
  • Ebay
    Ebay
  • Square
    Square

Commerce Metrics Formula

Rutter supports the ability to fetch commerce metrics from a commerce connection. This can be used to compute metrics such as Total Revenue without additional engineering work.

If you need a metric that is not currently supported, please contact us directly. We're happy to build new metrics as needed.

The metrics supported are listed below, along with the formula used to compute them:

Commerce MetricMetric Name (Used as Param)Formula
Total Revenuetotal_revenueSum of all order totals in a month
Total Orderstotal_ordersCount of all orders in a month
Active Customersactive_customersCount of all distinct customers who placed an order in a month (Note: Does not include customers who don't sign in)
Refund Raterefund_rateSum of all refunded orders in a month / Sum of all orders in a month

Have questions?

Contact support for personalized guidance.

Contact support
Previous
Store