List With Groups

Get usage data with paginated groupings

post/v1/usage/groups

Fetch aggregated usage data for the specified customer, billable-metric, and optional group, broken into intervals of the specified length.

Query Parameters

limitnumber

optional

Max number of results that should be returned

minimum1

maximum100

next_pagestring

optional

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

Body Parameters

billable_metric_idstring

formatuuid

customer_idstring

formatuuid

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"

current_periodboolean

optional

If true, will return the usage for the current billing period. Will return an error if the customer is currently uncontracted or starting_on and ending_before are specified when this is true.

ending_beforestring

optional

formatdate-time

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. Omit this if you'd like all values for the key returned.

starting_onstring

optional

formatdate-time

Returns

dataarray of object

next_pagestring

curl https://api.metronome.com/v1/usage/groups \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN" \
    -d '{
          "billable_metric_id": "222796fd-d29c-429e-89b2-549fabda4ed6",
          "customer_id": "04ca7e72-4229-4a6e-ab11-9f7376fccbcb",
          "window_size": "HOUR"
        }'

200 Example

{
  "data": [
    {
      "ending_before": "2019-12-27T18:11:19.117Z",
      "group_key": "group_key",
      "group_value": "group_value",
      "starting_on": "2019-12-27T18:11:19.117Z",
      "value": 0
    }
  ],
  "next_page": "next_page"
}