Sign in

v5

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

Get stream usage

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.

get/api/v2/usage/streams/{source}

Path parameters

sourcestring string required

The source of streaming connections to describe. Must be either client or server.

The source of streaming connections to describe. Must be either client or server.

Query parameters

fromstring string

The series of data returned starts from this timestamp. Defaults to 30 days ago.

The series of data returned starts from this timestamp. Defaults to 30 days ago.

tostring string

The series of data returned ends at this timestamp. Defaults to the current time.

The series of data returned ends at this timestamp. Defaults to the current time.

tzstring string

The timezone to use for breaks between days when returning daily data.

The timezone to use for breaks between days when returning daily data.

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