List With Groups

Get usage data with paginated groupings

v1.usage.list_with_groups(**kwargs) -> CursorPage<>

post/v1/usage/groups

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

Parameters

billable_metric_idString

formatuuid

customer_idString

formatuuid

window_sizeunion

:HOUR | :DAY | :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

limitInteger

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.

current_periodbool

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_beforeTime

optional

formatdate-time

group_byobject

optional

{ key, values}

Hide ParametersShow Parameters

keyString

The name of the group_by key to use

valuesarray

optional

Array[String]

Values of the group_by key to return in the query. Omit this if you'd like all values for the key returned.

starting_onTime

optional

formatdate-time

Returns

UsageListWithGroupsResponseclass

Hide ParametersShow Parameters

ending_beforeTime

formatdate-time

group_keyString

group_valueString

starting_onTime

formatdate-time

valueFloat

require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

page = metronome.v1.usage.list_with_groups(
  billable_metric_id: "222796fd-d29c-429e-89b2-549fabda4ed6",
  customer_id: "04ca7e72-4229-4a6e-ab11-9f7376fccbcb",
  window_size: :HOUR
)

puts(page)

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"
}