Account usage (beta)

Get data export events usage

GET
/api/v2/usage/data-export-events

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. groupBy=projectId resolves legacy rows through the account's current environment-to-project mapping and returns 409 instead of a partial series when any successful row remains unattributed. Plain project filtering keeps its current-environment compatibility behavior.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Query Parameters

from?string

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

Formatstring
to?string

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

Formatstring
projectKey?string

A project key to filter results by. Without groupBy=projectId, filters to the project's current environments so retained pre-materialization usage remains visible. Can be specified multiple times, one query parameter per project key.

Formatstring
environmentKey?string

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.

Formatstring
eventKind?string

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

Formatstring
destinationKind?string

A Streaming configuration kind to filter results by. Values preserve raw product identity; snowflake is legacy Streaming Snowflake and is distinct from Warehouse snowflake-v2. Can be specified multiple times.Valid values: kinesis, google-pubsub, mparticle, segment, azure-event-hubs, snowflake, unknown.

Formatstring
groupBy?string

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. projectId requires one or more explicit projectKey filters and is capped at 100 selected projects.Valid values: projectId, environmentId, eventKind, destinationKind.

Formatstring
aggregationType?string

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

Formatstring
granularity?string

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

Formatstring

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/usage/data-export-events"
{  "_links": {    "property1": null,    "property2": null  },  "metadata": [    {      "property1": null,      "property2": null    }  ],  "series": [    {      "0": 11,      "1": 15,      "time": 1677888000000    }  ]}