v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB
Account usage (beta)

Get contexts total usage

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.<br/><br/>The supported granularity varies by aggregation type. The maximum time range is 365 days.

get/api/v2/usage/total-contexts

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.

contextKindstring string

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

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

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.

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.

anonymousstring string

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: true, false.

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: true, false.

groupBystring string

If specified, returns data for each distinct value of the given field. contextKind is always included as a grouping dimension. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.<br/>Valid values: projectId, environmentId, sdkName, sdkType, sdkAppId, anonymousV2.

If specified, returns data for each distinct value of the given field. contextKind is always included as a grouping dimension. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.<br/>Valid values: projectId, environmentId, sdkName, sdkType, sdkAppId, anonymousV2.

aggregationTypestring string

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

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

granularitystring string

Specifies the data granularity. Defaults to daily. Valid values depend on aggregationType: month_to_date supports daily and monthly; incremental and rolling_30d support daily only.

Specifies the data granularity. Defaults to daily. Valid values depend on aggregationType: month_to_date supports daily and monthly; incremental and rolling_30d support daily only.

Response

Usage response

_linksobject required

The location and content type of related resources

metadataSeriesMetadataRep[] required

Metadata about each series

seriesSeriesTimeSliceRep[] 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
    }
  ]
}