OverviewAccount usage (beta)

Get data export events usage

Get a time series array showing the number of data export events from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Headers

AuthorizationstringRequired

Query parameters

fromstringOptional

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.

tostringOptional

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.

projectKeystringOptional
A project key to filter results by. Can be specified multiple times, one query parameter per project key.
environmentKeystringOptional

An environment key to filter results by. If specified, exactly one projectKey must be provided. Can be specified multiple times, one query parameter per environment key.

eventKindstringOptional
An event kind to filter results by. Can be specified multiple times, one query parameter per event kind.
groupBystringOptional

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.
Valid values: environmentId, eventKind.

aggregationTypestringOptional

Specifies the aggregation method. Defaults to month_to_date.
Valid values: month_to_date, incremental.

granularitystringOptional

Specifies the data granularity. Defaults to daily. monthly granularity is only supported with the month_to_date aggregation type.
Valid values: daily, hourly, monthly.

Response

Usage response
metadatalist of maps from strings to any
Metadata about each series
serieslist of maps from strings to integers

An array of data points with timestamps. Each element of the array is an object with a ‘time’ field, whose value is the timestamp, and one or more key fields. If there are multiple key fields, they are labeled ‘0’, ‘1’, and so on, and are explained in the metadata.

Errors