## 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`

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

`end_date`

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

`currency`

stringIf applicable, the currency used for the value returned.

`value`

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

```
{
"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 /metrics/commerce/:metricNameThe 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`

stringqueryThe access token of the connection.

`force_fetch`

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

### Response Body

`checkpoint`

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

`connection`

object`connection`

attributes`active_customers`

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

`active_customers`

attributes`amortization_expense`

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

`amortization_expense`

attributes`capital_expenditure`

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

`capital_expenditure`

attributes`change_in_working_capital`

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

`change_in_working_capital`

attributes`cost_of_goods_sold`

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

`cost_of_goods_sold`

attributes`current_assets`

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

`current_assets`

attributes`current_liabilities`

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

`current_liabilities`

attributes`current_ratio`

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

`current_ratio`

attributes`debt_service`

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

`debt_service`

attributes`debt_service_coverage_ratio`

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

`debt_service_coverage_ratio`

attributes`debt_service_from_income_statement`

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

`debt_service_from_income_statement`

attributes`debt_service_from_principal_paid`

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

`debt_service_from_principal_paid`

attributes`depreciation_expense`

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

`depreciation_expense`

attributes`ebitda`

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

`ebitda`

attributes`ebitda_margin`

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

`ebitda_margin`

attributes`enterprise_free_cash_flow`

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

`enterprise_free_cash_flow`

attributes`enterprise_free_cash_flow_formula_two`

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

`enterprise_free_cash_flow_formula_two`

attributes`gross_profit_margin`

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

`gross_profit_margin`

attributes`interest_expense`

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

`interest_expense`

attributes`inventory`

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

`inventory`

attributes`net_income`

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

`net_income`

attributes`net_operating_income`

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

`net_operating_income`

attributes`prepaid_expenses`

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

`prepaid_expenses`

attributes`principal_paid`

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

`principal_paid`

attributes`quick_ratio`

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

`quick_ratio`

attributes`refund_rate`

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

`refund_rate`

attributes`rental_expense`

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

`rental_expense`

attributes`total_expenses`

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

`total_expenses`

attributes`total_income`

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

`total_income`

attributes`total_orders`

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

`total_orders`

attributes`total_revenue`

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

`total_revenue`

attributes`unearned_revenues`

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

`unearned_revenues`

attributes`working_capital`

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

`working_capital`

attributes