LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Account usage (beta)

Get service connections usage

GET
/api/v2/usage/service-connections

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.

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
connectionType?string

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

Formatstring
relayVersion?string

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

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
Deprecated

Deprecated. This endpoint reports server-side connections only, so server is the only value that returns data and omitting the parameter is equivalent. Any other value returns an empty series. To report client-side connections, use GET /api/v2/usage/streams/{source}.

Formatstring
sdkAppId?string

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

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, connectionType, relayVersion, sdkName, sdkVersion, sdkAppId.sdkType is no longer offered: this endpoint reports server-side connections only, so grouping by it returns a single group. It is still accepted, for compatibility.

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/service-connections"
{  "_links": {    "property1": null,    "property2": null  },  "metadata": [    {      "property1": null,      "property2": null    }  ],  "series": [    {      "0": 11,      "1": 15,      "time": 1677888000000    }  ],  "projectedSeries": [    {      "0": 11,      "time": 1677888000000    }  ]}

Get contexts serverside usage GET

Get a detailed time series of the number of context key usages observed by LaunchDarkly in your account, including non-primary context kinds. Use this for breakdowns that go beyond the primary-only aggregation of MAU endpoints. The counts reflect data reported by server-side SDKs.<br/><br/>The supported granularity varies by aggregation type. The maximum time range is 365 days.

Get stream usage GET

Get a time-series array of the number of streaming connections to LaunchDarkly in each time period. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.