v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Account usage (beta)

Get service connections usage

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

get/api/v2/usage/service-connections

Query parameters

fromstring string

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

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

tostring string

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

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

projectKeystring string

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

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

environmentKeystring 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.

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.

connectionTypestring string

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

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

relayVersionstring string

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

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

sdkNamestring string

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

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

sdkVersionstring string

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

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

sdkTypestring string

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

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

groupBystring 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.<br/>Valid values: projectId, environmentId, connectionType, relayVersion, sdkName, sdkVersion, sdkType.

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

aggregationTypestring string

Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental.

Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental.

granularitystring string

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

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

Response

Usage response

_linksobject required

The location and content type of related resources

metadataSeriesMetadataRep[] required

Metadata about each series

seriesSeriesTimeSliceRepFloat[] required

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 <code>metadata</code>.

Example response

{
  "series": [
    {
      "0": 11,
      "1": 15,
      "time": 1677888000000
    }
  ]
}