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_date
stringRequiredThe starting date from which we start aggregating activity (revenue, expenses, etc).
end_date
stringRequiredThe date at which we stop aggregating activity (revenue, expenses, etc).
currency
stringRequiredIf applicable, the currency used for the value returned.
value
stringRequiredThe value of the requested metric for the time range described by the start and end date.
Fetch a Metric
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_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
checkpoint
stringRequiredThe ISO 8601 timestamp for the date at which the metric was last updated.
connection
objectRequiredconnection
attributesactive_customers
arrayThe metric value and important metadata that defines the method of calculation.
active_customers
attributesamortization_expense
arrayThe metric value and important metadata that defines the method of calculation.
amortization_expense
attributescapital_expenditure
arrayThe metric value and important metadata that defines the method of calculation.
capital_expenditure
attributescash_flow_to_debt_ratio
arrayThe metric value and important metadata that defines the method of calculation.
cash_flow_to_debt_ratio
attributeschange_in_working_capital
arrayThe metric value and important metadata that defines the method of calculation.
change_in_working_capital
attributescost_of_goods_sold
arrayThe metric value and important metadata that defines the method of calculation.
cost_of_goods_sold
attributescurrent_assets
arrayThe metric value and important metadata that defines the method of calculation.
current_assets
attributescurrent_liabilities
arrayThe metric value and important metadata that defines the method of calculation.
current_liabilities
attributescurrent_ratio
arrayThe metric value and important metadata that defines the method of calculation.
current_ratio
attributesdebt_service
arrayThe metric value and important metadata that defines the method of calculation.
debt_service
attributesdebt_service_coverage_ratio
arrayThe metric value and important metadata that defines the method of calculation.
debt_service_coverage_ratio
attributesdebt_service_from_income_statement
arrayThe metric value and important metadata that defines the method of calculation.
debt_service_from_income_statement
attributesdebt_service_from_principal_paid
arrayThe metric value and important metadata that defines the method of calculation.
debt_service_from_principal_paid
attributesdebt_to_income_ratio
arrayThe metric value and important metadata that defines the method of calculation.
debt_to_income_ratio
attributesdepreciation_expense
arrayThe metric value and important metadata that defines the method of calculation.
depreciation_expense
attributesebitda
arrayThe metric value and important metadata that defines the method of calculation.
ebitda
attributesebitda_margin
arrayThe metric value and important metadata that defines the method of calculation.
ebitda_margin
attributesenterprise_free_cash_flow
arrayThe metric value and important metadata that defines the method of calculation.
enterprise_free_cash_flow
attributesenterprise_free_cash_flow_formula_two
arrayThe metric value and important metadata that defines the method of calculation.
enterprise_free_cash_flow_formula_two
attributesgross_profit_margin
arrayThe metric value and important metadata that defines the method of calculation.
gross_profit_margin
attributesinterest_expense
arrayThe metric value and important metadata that defines the method of calculation.
interest_expense
attributesinventory
arrayThe metric value and important metadata that defines the method of calculation.
inventory
attributesnet_income
arrayThe metric value and important metadata that defines the method of calculation.
net_income
attributesnet_operating_income
arrayThe metric value and important metadata that defines the method of calculation.
net_operating_income
attributesnet_profit_margin
arrayThe metric value and important metadata that defines the method of calculation.
net_profit_margin
attributesprepaid_expenses
arrayThe metric value and important metadata that defines the method of calculation.
prepaid_expenses
attributesprincipal_paid
arrayThe metric value and important metadata that defines the method of calculation.
principal_paid
attributesquick_ratio
arrayThe metric value and important metadata that defines the method of calculation.
quick_ratio
attributesrefund_rate
arrayThe metric value and important metadata that defines the method of calculation.
refund_rate
attributesrental_expense
arrayThe metric value and important metadata that defines the method of calculation.
rental_expense
attributestotal_expenses
arrayThe metric value and important metadata that defines the method of calculation.
total_expenses
attributestotal_income
arrayThe metric value and important metadata that defines the method of calculation.
total_income
attributestotal_orders
arrayThe metric value and important metadata that defines the method of calculation.
total_orders
attributestotal_revenue
arrayThe metric value and important metadata that defines the method of calculation.
total_revenue
attributesunearned_revenues
arrayThe metric value and important metadata that defines the method of calculation.
unearned_revenues
attributesworking_capital
arrayThe metric value and important metadata that defines the method of calculation.
working_capital
attributes- Shopify
- Amazon
- Ebay
- 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 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.