Aggregate Metrics

Commerce Metrics
Get API Keys

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_datestring

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

end_datestring

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

currencystring

If applicable, the currency used for the value returned.

valuestring

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

Example AggregateMetric Object
{
  "start_date": "2022-05-01T00:00:00.000Z",
  "end_date": "2022-05-31T23:59:59.999Z",
  "currency": "USD",
  "value": "-1149613.2900"
}

Fetch a Metric

GET /commerce/metrics/:metricName
Supported for: AmazonBig CommerceeBayLazadaMagentoShopeeShopifySquare

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_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

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

    One oftrue or false.

Response Body

    checkpointstring

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

    connectionobject
    Show connection attributes
    active_customersarrayoptional

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

    Show active_customers attributes
    amortization_expensearrayoptional

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

    Show amortization_expense attributes
    capital_expenditurearrayoptional

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

    Show capital_expenditure attributes
    cash_flow_to_debt_ratioarrayoptional

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

    Show cash_flow_to_debt_ratio attributes
    change_in_working_capitalarrayoptional

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

    Show change_in_working_capital attributes
    cost_of_goods_soldarrayoptional

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

    Show cost_of_goods_sold attributes
    current_assetsarrayoptional

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

    Show current_assets attributes
    current_liabilitiesarrayoptional

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

    Show current_liabilities attributes
    current_ratioarrayoptional

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

    Show current_ratio attributes
    debt_servicearrayoptional

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

    Show debt_service attributes
    debt_service_coverage_ratioarrayoptional

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

    Show debt_service_coverage_ratio attributes
    debt_service_from_income_statementarrayoptional

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

    Show debt_service_from_income_statement attributes
    debt_service_from_principal_paidarrayoptional

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

    Show debt_service_from_principal_paid attributes
    debt_to_income_ratioarrayoptional

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

    Show debt_to_income_ratio attributes
    depreciation_expensearrayoptional

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

    Show depreciation_expense attributes
    ebitdaarrayoptional

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

    Show ebitda attributes
    ebitda_marginarrayoptional

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

    Show ebitda_margin attributes
    enterprise_free_cash_flowarrayoptional

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

    Show enterprise_free_cash_flow attributes
    enterprise_free_cash_flow_formula_twoarrayoptional

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

    Show enterprise_free_cash_flow_formula_two attributes
    gross_profit_marginarrayoptional

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

    Show gross_profit_margin attributes
    interest_expensearrayoptional

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

    Show interest_expense attributes
    inventoryarrayoptional

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

    Show inventory attributes
    net_incomearrayoptional

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

    Show net_income attributes
    net_operating_incomearrayoptional

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

    Show net_operating_income attributes
    net_profit_marginarrayoptional

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

    Show net_profit_margin attributes
    prepaid_expensesarrayoptional

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

    Show prepaid_expenses attributes
    principal_paidarrayoptional

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

    Show principal_paid attributes
    quick_ratioarrayoptional

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

    Show quick_ratio attributes
    refund_ratearrayoptional

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

    Show refund_rate attributes
    rental_expensearrayoptional

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

    Show rental_expense attributes
    total_expensesarrayoptional

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

    Show total_expenses attributes
    total_incomearrayoptional

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

    Show total_income attributes
    total_ordersarrayoptional

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

    Show total_orders attributes
    total_revenuearrayoptional

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

    Show total_revenue attributes
    unearned_revenuesarrayoptional

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

    Show unearned_revenues attributes
    working_capitalarrayoptional

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

    Show working_capital attributes