Account usage (beta)

Get AI runs usage

GET
/api/v2/usage/ai-runs

Get a time series array showing the number of AI runs recorded for your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.

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. 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
sdkName?string

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

Formatstring
sdkVersion?string

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

Formatstring
sdkType?string

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

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.Valid values: projectId, environmentId, sdkName, sdkVersion, sdkType.

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

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