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_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.

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

    metricNameenumpathRequired

    The path of the commerce metric.

    One oftotal_revenue, total_orders, active_customers, or refund_rate.
    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

    checkpointstring

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

    active_customersarrayOptional

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

    Show active_customers attributes
    refund_ratearrayOptional

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

    Show refund_rate 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
    connectionobject
    Show connection 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