GET /v1/billing/meters/{id}/event_summaries

Retrieve a list of billing meter event summaries.

Servers

Path parameters

Name Type Required Description
id String Yes

Unique identifier for the object.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Query parameters

Name Type Required Description
customer String Yes

The customer for which to fetch event summaries.

limit Integer No

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

start_time Integer Yes

The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.

starting_after String No

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

expand[] Array No

Specifies which fields in the response should be expanded.

ending_before String No

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

value_grouping_window String No

Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).

Possible values:

  • "day"
  • "hour"
end_time Integer Yes

The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.