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.

Please note that the metrics are only available for the past year of data (i.e. you can only get the last 12 monthly reports of data).

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

Support by integration

Expand to view platform rules

Shopify
Amazon
eBay
PayPal

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 Metric	Metric Name (Used as Param)	Formula
Total Revenue	total_revenue	Sum of all order totals in a month
Total Orders	total_orders	Count of all orders in a month
Active Customers	active_customers	Count of all distinct customers who placed an order in a month (Note: Does not include customers who don't sign in)
Refund Rate	refund_rate	Sum of all refunded orders in a month / Sum of all orders in a month

Have questions?

Contact support for personalized guidance.

Contact support