Skip to content
Metronome Docs
  • Auto
  • Light
  • Dark
Talk to an expert

List

API Reference
V1
Usage
Get batched usage data
post/v1/usage

Fetch aggregated usage data for multiple customers and billable-metrics, broken into intervals of the specified length.

Query Parameters
next_pagestring
optional

Cursor that indicates where the next page of results should start.

Body Parameters
ending_beforestring
formatdate-time
starting_onstring
formatdate-time
window_sizeenum
"HOUR" OR "DAY" OR "NONE"

A window_size of "day" or "hour" will return the usage for the specified period segmented into daily or hourly aggregates. A window_size of "none" will return a single usage aggregate for the entirety of the specified period.

Hide ParametersShow Parameters
"HOUR"
"DAY"
"NONE"
billable_metricsarray of object
optional

A list of billable metrics to fetch usage for. If absent, all billable metrics will be returned.

Hide ParametersShow Parameters
idstring
formatuuid
group_byobject
optional
Hide ParametersShow Parameters
keystring

The name of the group_by key to use

valuesarray of string
optional

Values of the group_by key to return in the query. If this field is omitted, all available values will be returned, up to a maximum of 200.

customer_idsarray of string
optional

A list of Metronome customer IDs to fetch usage for. If absent, usage for all customers will be returned.

Returns
dataarray of object
Hide ParametersShow Parameters
billable_metric_idstring
formatuuid
billable_metric_namestring
customer_idstring
formatuuid
end_timestampstring
formatdate-time
start_timestampstring
formatdate-time
valuenumber
groupsmap
optional

Values will be either a number or null. Null indicates that there were no matches for the group_by value.

next_pagestring
curl https://api.metronome.com/v1/usage \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN" \
    -d '{
          "ending_before": "2021-01-03T00:00:00Z",
          "starting_on": "2021-01-01T00:00:00Z",
          "window_size": "HOUR"
        }'
200 Example
{
  "data": [
    {
      "billable_metric_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "billable_metric_name": "billable_metric_name",
      "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "end_timestamp": "2019-12-27T18:11:19.117Z",
      "start_timestamp": "2019-12-27T18:11:19.117Z",
      "value": 0,
      "groups": {
        "foo": 0
      }
    }
  ],
  "next_page": "next_page"
}