All URIs are relative to https://app.launchdarkly.com
| Method | HTTP request | Description |
|---|---|---|
| getContextsClientsideUsage | GET /api/v2/usage/clientside-contexts | Get contexts clientside usage |
| getContextsServersideUsage | GET /api/v2/usage/serverside-contexts | Get contexts serverside usage |
| getContextsTotalUsage | GET /api/v2/usage/total-contexts | Get contexts total usage |
| getDataExportEventsUsage | GET /api/v2/usage/data-export-events | Get data export events usage |
| getEvaluationsUsage | GET /api/v2/usage/evaluations/{projectKey}/{environmentKey}/{featureFlagKey} | Get evaluations usage |
| getEventsUsage | GET /api/v2/usage/events/{type} | Get events usage |
| getExperimentationEventsUsage | GET /api/v2/usage/experimentation-events | Get experimentation events usage |
| getExperimentationKeysUsage | GET /api/v2/usage/experimentation-keys | Get experimentation keys usage |
| getMAUClientsideUsage | GET /api/v2/usage/clientside-mau | Get MAU clientside usage |
| getMAUTotalUsage | GET /api/v2/usage/total-mau | Get MAU total usage |
| getMauSdksByType | GET /api/v2/usage/mau/sdks | Get MAU SDKs by type |
| getMauUsage | GET /api/v2/usage/mau | Get MAU usage |
| getMauUsageByCategory | GET /api/v2/usage/mau/bycategory | Get MAU usage by category |
| getObservabilityErrorsUsage | GET /api/v2/usage/observability/errors | Get observability errors usage |
| getObservabilityLogsUsage | GET /api/v2/usage/observability/logs | Get observability logs usage |
| getObservabilityMetricsUsage | GET /api/v2/usage/observability/metrics | Get observability metrics usage |
| getObservabilitySessionsUsage | GET /api/v2/usage/observability/sessions | Get observability sessions usage |
| getObservabilityTracesUsage | GET /api/v2/usage/observability/traces | Get observability traces usage |
| getServiceConnectionsUsage | GET /api/v2/usage/service-connections | Get service connections usage |
| getStreamUsage | GET /api/v2/usage/streams/{source} | Get stream usage |
| getStreamUsageBySdkVersion | GET /api/v2/usage/streams/{source}/bysdkversion | Get stream usage by SDK version |
| getStreamUsageSdkversion | GET /api/v2/usage/streams/{source}/sdkversions | Get stream usage SDK versions |
| getVegaAIUsage | GET /api/v2/usage/vega-ai | Get Vega AI usage |
SeriesListRep getContextsClientsideUsage()
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 client-side SDKs.
The supported granularity varies by aggregation type. The maximum time range is 365 days.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let 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. (optional) (default to undefined)
let contextKind: string; //A context kind to filter results by. Can be specified multiple times, one query parameter per context kind. (optional) (default to undefined)
let sdkName: string; //An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. (optional) (default to undefined)
let anonymous: string; //An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. (optional) (default to undefined)
let groupBy: 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`, `sdkAppId`, `anonymousV2`. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. (optional) (default to undefined)
let granularity: 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. (optional) (default to undefined)
const { status, data } = await apiInstance.getContextsClientsideUsage(
from,
to,
projectKey,
environmentKey,
contextKind,
sdkName,
anonymous,
groupBy,
aggregationType,
granularity
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| 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. | (optional) defaults to undefined |
| contextKind | [string] | A context kind to filter results by. Can be specified multiple times, one query parameter per context kind. | (optional) defaults to undefined |
| sdkName | [string] | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. | (optional) defaults to undefined |
| anonymous | [string] | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. | (optional) defaults to undefined |
| groupBy | [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`, `sdkAppId`, `anonymousV2`. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | (optional) defaults to undefined |
| granularity | [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. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
| 503 | Service unavailable | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getContextsServersideUsage()
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.
The supported granularity varies by aggregation type. The maximum time range is 365 days.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let 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. (optional) (default to undefined)
let contextKind: string; //A context kind to filter results by. Can be specified multiple times, one query parameter per context kind. (optional) (default to undefined)
let sdkName: string; //An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. (optional) (default to undefined)
let anonymous: string; //An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. (optional) (default to undefined)
let groupBy: 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`, `sdkAppId`, `anonymousV2`. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. (optional) (default to undefined)
let granularity: 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. (optional) (default to undefined)
const { status, data } = await apiInstance.getContextsServersideUsage(
from,
to,
projectKey,
environmentKey,
contextKind,
sdkName,
anonymous,
groupBy,
aggregationType,
granularity
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| 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. | (optional) defaults to undefined |
| contextKind | [string] | A context kind to filter results by. Can be specified multiple times, one query parameter per context kind. | (optional) defaults to undefined |
| sdkName | [string] | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. | (optional) defaults to undefined |
| anonymous | [string] | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. | (optional) defaults to undefined |
| groupBy | [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`, `sdkAppId`, `anonymousV2`. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | (optional) defaults to undefined |
| granularity | [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. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
| 503 | Service unavailable | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getContextsTotalUsage()
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 supported granularity varies by aggregation type. The maximum time range is 365 days.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let 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. (optional) (default to undefined)
let contextKind: string; //A context kind to filter results by. Can be specified multiple times, one query parameter per context kind. (optional) (default to undefined)
let sdkName: string; //An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. (optional) (default to undefined)
let sdkType: string; //An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type. (optional) (default to undefined)
let anonymous: string; //An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. (optional) (default to undefined)
let groupBy: 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`. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. (optional) (default to undefined)
let granularity: 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. (optional) (default to undefined)
const { status, data } = await apiInstance.getContextsTotalUsage(
from,
to,
projectKey,
environmentKey,
contextKind,
sdkName,
sdkType,
anonymous,
groupBy,
aggregationType,
granularity
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| 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. | (optional) defaults to undefined |
| contextKind | [string] | A context kind to filter results by. Can be specified multiple times, one query parameter per context kind. | (optional) defaults to undefined |
| sdkName | [string] | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. | (optional) defaults to undefined |
| sdkType | [string] | An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type. | (optional) defaults to undefined |
| anonymous | [string] | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. | (optional) defaults to undefined |
| groupBy | [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`. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | (optional) defaults to undefined |
| granularity | [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. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
| 503 | Service unavailable | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getDataExportEventsUsage()
Get a time series array showing the number of data export events from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let 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. (optional) (default to undefined)
let eventKind: string; //An event kind to filter results by. Can be specified multiple times, one query parameter per event kind. (optional) (default to undefined)
let 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.<br/>Valid values: `environmentId`, `eventKind`. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`. (optional) (default to undefined)
let granularity: 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`. (optional) (default to undefined)
const { status, data } = await apiInstance.getDataExportEventsUsage(
from,
to,
projectKey,
environmentKey,
eventKind,
groupBy,
aggregationType,
granularity
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| 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. | (optional) defaults to undefined |
| eventKind | [string] | An event kind to filter results by. Can be specified multiple times, one query parameter per event kind. | (optional) defaults to undefined |
| 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.<br/>Valid values: `environmentId`, `eventKind`. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`. | (optional) defaults to undefined |
| granularity | [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`. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
| 503 | Service unavailable | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getEvaluationsUsage()
Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. 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.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let projectKey: string; //The project key (default to undefined)
let environmentKey: string; //The environment key (default to undefined)
let featureFlagKey: string; //The feature flag key (default to undefined)
let from: string; //The series of data returned starts from this timestamp. Defaults to 30 days ago. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp. Defaults to the current time. (optional) (default to undefined)
let tz: string; //The timezone to use for breaks between days when returning daily data. (optional) (default to undefined)
const { status, data } = await apiInstance.getEvaluationsUsage(
projectKey,
environmentKey,
featureFlagKey,
from,
to,
tz
);| Name | Type | Description | Notes |
|---|---|---|---|
| projectKey | [string] | The project key | defaults to undefined |
| environmentKey | [string] | The environment key | defaults to undefined |
| featureFlagKey | [string] | The feature flag key | defaults to undefined |
| from | [string] | The series of data returned starts from this timestamp. Defaults to 30 days ago. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp. Defaults to the current time. | (optional) defaults to undefined |
| tz | [string] | The timezone to use for breaks between days when returning daily data. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getEventsUsage()
Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. 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.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let type: string; //The type of event to retrieve. Must be either `received` or `published`. (default to undefined)
let from: string; //The series of data returned starts from this timestamp. Defaults to 24 hours ago. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp. Defaults to the current time. (optional) (default to undefined)
const { status, data } = await apiInstance.getEventsUsage(
type,
from,
to
);| Name | Type | Description | Notes |
|---|---|---|---|
| type | [string] | The type of event to retrieve. Must be either `received` or `published`. | defaults to undefined |
| from | [string] | The series of data returned starts from this timestamp. Defaults to 24 hours ago. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp. Defaults to the current time. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getExperimentationEventsUsage()
Get a time series array showing the number of experimentation events from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let 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. (optional) (default to undefined)
let eventKey: string; //An event key to filter results by. Can be specified multiple times, one query parameter per event key. (optional) (default to undefined)
let eventKind: string; //An event kind to filter results by. Can be specified multiple times, one query parameter per event kind. (optional) (default to undefined)
let 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.<br/>Valid values: `environmentId`, `eventKey`, `eventKind`. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`. (optional) (default to undefined)
let granularity: 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`. (optional) (default to undefined)
const { status, data } = await apiInstance.getExperimentationEventsUsage(
from,
to,
projectKey,
environmentKey,
eventKey,
eventKind,
groupBy,
aggregationType,
granularity
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| 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. | (optional) defaults to undefined |
| eventKey | [string] | An event key to filter results by. Can be specified multiple times, one query parameter per event key. | (optional) defaults to undefined |
| eventKind | [string] | An event kind to filter results by. Can be specified multiple times, one query parameter per event kind. | (optional) defaults to undefined |
| 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.<br/>Valid values: `environmentId`, `eventKey`, `eventKind`. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`. | (optional) defaults to undefined |
| granularity | [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`. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
| 503 | Service unavailable | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getExperimentationKeysUsage()
Get a time series array showing the number of experimentation keys from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let 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. (optional) (default to undefined)
let experimentId: string; //An experiment ID to filter results by. Can be specified multiple times, one query parameter per experiment ID. (optional) (default to undefined)
let 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.<br/>Valid values: `projectId`, `environmentId`, `experimentId`. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`. (optional) (default to undefined)
let granularity: 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`. (optional) (default to undefined)
const { status, data } = await apiInstance.getExperimentationKeysUsage(
from,
to,
projectKey,
environmentKey,
experimentId,
groupBy,
aggregationType,
granularity
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| 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. | (optional) defaults to undefined |
| experimentId | [string] | An experiment ID to filter results by. Can be specified multiple times, one query parameter per experiment ID. | (optional) defaults to undefined |
| 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.<br/>Valid values: `projectId`, `environmentId`, `experimentId`. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`. | (optional) defaults to undefined |
| granularity | [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`. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
| 503 | Service unavailable | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getMAUClientsideUsage()
Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only. The counts reflect data reported from client-side SDKs.
For past months, the primary context kind is fixed and reflects the last known primary kind for that month. For the current month, it may vary as new primary context kinds are observed.
The supported granularity varies by aggregation type. The maximum time range is 365 days.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let 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. (optional) (default to undefined)
let sdkName: string; //An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. (optional) (default to undefined)
let anonymous: string; //An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. (optional) (default to undefined)
let 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.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. (optional) (default to undefined)
let granularity: 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. (optional) (default to undefined)
const { status, data } = await apiInstance.getMAUClientsideUsage(
from,
to,
projectKey,
environmentKey,
sdkName,
anonymous,
groupBy,
aggregationType,
granularity
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| 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. | (optional) defaults to undefined |
| sdkName | [string] | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. | (optional) defaults to undefined |
| anonymous | [string] | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. | (optional) defaults to undefined |
| 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.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | (optional) defaults to undefined |
| granularity | [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. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
| 503 | Service unavailable | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getMAUTotalUsage()
Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only.
For past months, this reflects the context kind that was most recently marked as primary for that month. For the current month, the context kind may vary as new primary kinds are observed.
The supported granularity varies by aggregation type. The maximum time range is 365 days.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let 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. (optional) (default to undefined)
let sdkName: string; //An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. (optional) (default to undefined)
let sdkType: string; //An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type. (optional) (default to undefined)
let anonymous: string; //An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. (optional) (default to undefined)
let 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.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkType`, `sdkAppId`, `anonymousV2`. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. (optional) (default to undefined)
let granularity: 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. (optional) (default to undefined)
const { status, data } = await apiInstance.getMAUTotalUsage(
from,
to,
projectKey,
environmentKey,
sdkName,
sdkType,
anonymous,
groupBy,
aggregationType,
granularity
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| 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. | (optional) defaults to undefined |
| sdkName | [string] | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. | (optional) defaults to undefined |
| sdkType | [string] | An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type. | (optional) defaults to undefined |
| anonymous | [string] | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. | (optional) defaults to undefined |
| 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.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkType`, `sdkAppId`, `anonymousV2`. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | (optional) defaults to undefined |
| granularity | [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. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
| 503 | Service unavailable | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SdkListRep getMauSdksByType()
Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.
Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read Account usage metrics.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The data returned starts from this timestamp. Defaults to seven days ago. The timestamp is in Unix milliseconds, for example, 1656694800000. (optional) (default to undefined)
let to: string; //The data returned ends at this timestamp. Defaults to the current time. The timestamp is in Unix milliseconds, for example, 1657904400000. (optional) (default to undefined)
let sdktype: string; //The type of SDK with monthly active users (MAU) to list. Must be either `client` or `server`. (optional) (default to undefined)
const { status, data } = await apiInstance.getMauSdksByType(
from,
to,
sdktype
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The data returned starts from this timestamp. Defaults to seven days ago. The timestamp is in Unix milliseconds, for example, 1656694800000. | (optional) defaults to undefined |
| to | [string] | The data returned ends at this timestamp. Defaults to the current time. The timestamp is in Unix milliseconds, for example, 1657904400000. | (optional) defaults to undefined |
| sdktype | [string] | The type of SDK with monthly active users (MAU) to list. Must be either `client` or `server`. | (optional) defaults to undefined |
SdkListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | MAU SDKs response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getMauUsage()
Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.
Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read Account usage metrics.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp. Defaults to 30 days ago. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp. Defaults to the current time. (optional) (default to undefined)
let project: string; //A project key to filter results to. Can be specified multiple times, one query parameter per project key, to view data for multiple projects. (optional) (default to undefined)
let environment: string; //An environment key to filter results to. When using this parameter, exactly one project key must also be set. Can be specified multiple times as separate query parameters to view data for multiple environments within a single project. (optional) (default to undefined)
let sdktype: string; //An SDK type to filter results to. Can be specified multiple times, one query parameter per SDK type. Valid values: client, server (optional) (default to undefined)
let sdk: string; //An SDK name to filter results to. Can be specified multiple times, one query parameter per SDK. (optional) (default to undefined)
let anonymous: string; //If specified, filters results to either anonymous or nonanonymous users. (optional) (default to undefined)
let 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 (for example, to group by both project and SDK). Valid values: project, environment, sdktype, sdk, anonymous, contextKind, sdkAppId (optional) (default to undefined)
let aggregationType: string; //If specified, queries for rolling 30-day, month-to-date, or daily incremental counts. Default is rolling 30-day. Valid values: rolling_30d, month_to_date, daily_incremental (optional) (default to undefined)
let contextKind: string; //Filters results to the specified context kinds. Can be specified multiple times, one query parameter per context kind. If not set, queries for the user context kind. (optional) (default to undefined)
const { status, data } = await apiInstance.getMauUsage(
from,
to,
project,
environment,
sdktype,
sdk,
anonymous,
groupby,
aggregationType,
contextKind
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp. Defaults to 30 days ago. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp. Defaults to the current time. | (optional) defaults to undefined |
| project | [string] | A project key to filter results to. Can be specified multiple times, one query parameter per project key, to view data for multiple projects. | (optional) defaults to undefined |
| environment | [string] | An environment key to filter results to. When using this parameter, exactly one project key must also be set. Can be specified multiple times as separate query parameters to view data for multiple environments within a single project. | (optional) defaults to undefined |
| sdktype | [string] | An SDK type to filter results to. Can be specified multiple times, one query parameter per SDK type. Valid values: client, server | (optional) defaults to undefined |
| sdk | [string] | An SDK name to filter results to. Can be specified multiple times, one query parameter per SDK. | (optional) defaults to undefined |
| anonymous | [string] | If specified, filters results to either anonymous or nonanonymous users. | (optional) defaults to undefined |
| 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 (for example, to group by both project and SDK). Valid values: project, environment, sdktype, sdk, anonymous, contextKind, sdkAppId | (optional) defaults to undefined |
| aggregationType | [string] | If specified, queries for rolling 30-day, month-to-date, or daily incremental counts. Default is rolling 30-day. Valid values: rolling_30d, month_to_date, daily_incremental | (optional) defaults to undefined |
| contextKind | [string] | Filters results to the specified context kinds. Can be specified multiple times, one query parameter per context kind. If not set, queries for the user context kind. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getMauUsageByCategory()
Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either browser, mobile, or backend.
Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read Account usage metrics.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp. Defaults to 30 days ago. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp. Defaults to the current time. (optional) (default to undefined)
const { status, data } = await apiInstance.getMauUsageByCategory(
from,
to
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp. Defaults to 30 days ago. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp. Defaults to the current time. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getObservabilityErrorsUsage()
Get time-series arrays of the number of observability errors. Supports daily and monthly granularity.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let granularity: 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. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. (optional) (default to undefined)
const { status, data } = await apiInstance.getObservabilityErrorsUsage(
from,
to,
projectKey,
granularity,
aggregationType
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| granularity | [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. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getObservabilityLogsUsage()
Get time-series arrays of the number of observability logs. Supports daily and monthly granularity.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let granularity: 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. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. (optional) (default to undefined)
const { status, data } = await apiInstance.getObservabilityLogsUsage(
from,
to,
projectKey,
granularity,
aggregationType
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| granularity | [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. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getObservabilityMetricsUsage()
Get time-series arrays of the number of observability metrics. Supports daily and monthly granularity.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let granularity: 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. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. (optional) (default to undefined)
const { status, data } = await apiInstance.getObservabilityMetricsUsage(
from,
to,
projectKey,
granularity,
aggregationType
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| granularity | [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. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getObservabilitySessionsUsage()
Get time-series arrays of the number of observability sessions. Supports daily and monthly granularity.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let granularity: 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. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. (optional) (default to undefined)
const { status, data } = await apiInstance.getObservabilitySessionsUsage(
from,
to,
projectKey,
granularity,
aggregationType
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| granularity | [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. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getObservabilityTracesUsage()
Get time-series arrays of the number of observability traces. Supports daily and monthly granularity.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let granularity: 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. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. (optional) (default to undefined)
const { status, data } = await apiInstance.getObservabilityTracesUsage(
from,
to,
projectKey,
granularity,
aggregationType
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| granularity | [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. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRepFloat getServiceConnectionsUsage()
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.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let 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. (optional) (default to undefined)
let connectionType: string; //A connection type to filter results by. Can be specified multiple times, one query parameter per connection type. (optional) (default to undefined)
let relayVersion: string; //A relay version to filter results by. Can be specified multiple times, one query parameter per relay version. (optional) (default to undefined)
let sdkName: string; //An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. (optional) (default to undefined)
let sdkVersion: string; //An SDK version to filter results by. Can be specified multiple times, one query parameter per SDK version. (optional) (default to undefined)
let sdkType: string; //An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type. (optional) (default to undefined)
let 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.<br/>Valid values: `projectId`, `environmentId`, `connectionType`, `relayVersion`, `sdkName`, `sdkVersion`, `sdkType`. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`. (optional) (default to undefined)
let granularity: 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`. (optional) (default to undefined)
const { status, data } = await apiInstance.getServiceConnectionsUsage(
from,
to,
projectKey,
environmentKey,
connectionType,
relayVersion,
sdkName,
sdkVersion,
sdkType,
groupBy,
aggregationType,
granularity
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| 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. | (optional) defaults to undefined |
| connectionType | [string] | A connection type to filter results by. Can be specified multiple times, one query parameter per connection type. | (optional) defaults to undefined |
| relayVersion | [string] | A relay version to filter results by. Can be specified multiple times, one query parameter per relay version. | (optional) defaults to undefined |
| sdkName | [string] | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. | (optional) defaults to undefined |
| sdkVersion | [string] | An SDK version to filter results by. Can be specified multiple times, one query parameter per SDK version. | (optional) defaults to undefined |
| sdkType | [string] | An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type. | (optional) defaults to undefined |
| 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.<br/>Valid values: `projectId`, `environmentId`, `connectionType`, `relayVersion`, `sdkName`, `sdkVersion`, `sdkType`. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`. | (optional) defaults to undefined |
| granularity | [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`. | (optional) defaults to undefined |
SeriesListRepFloat
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
| 503 | Service unavailable | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getStreamUsage()
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.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let source: string; //The source of streaming connections to describe. Must be either `client` or `server`. (default to undefined)
let from: string; //The series of data returned starts from this timestamp. Defaults to 30 days ago. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp. Defaults to the current time. (optional) (default to undefined)
let tz: string; //The timezone to use for breaks between days when returning daily data. (optional) (default to undefined)
const { status, data } = await apiInstance.getStreamUsage(
source,
from,
to,
tz
);| Name | Type | Description | Notes |
|---|---|---|---|
| source | [string] | The source of streaming connections to describe. Must be either `client` or `server`. | defaults to undefined |
| from | [string] | The series of data returned starts from this timestamp. Defaults to 30 days ago. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp. Defaults to the current time. | (optional) defaults to undefined |
| tz | [string] | The timezone to use for breaks between days when returning daily data. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getStreamUsageBySdkVersion()
Get multiple series of the number of streaming connections to LaunchDarkly in each time period, separated by SDK type and version. Information about each series is in the metadata array. The granularity of the data depends on the age of the data requested. If the requested range is within the past 2 hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let source: string; //The source of streaming connections to describe. Must be either `client` or `server`. (default to undefined)
let from: string; //The series of data returned starts from this timestamp. Defaults to 24 hours ago. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp. Defaults to the current time. (optional) (default to undefined)
let tz: string; //The timezone to use for breaks between days when returning daily data. (optional) (default to undefined)
let sdk: string; //If included, this filters the returned series to only those that match this SDK name. (optional) (default to undefined)
let version: string; //If included, this filters the returned series to only those that match this SDK version. (optional) (default to undefined)
const { status, data } = await apiInstance.getStreamUsageBySdkVersion(
source,
from,
to,
tz,
sdk,
version
);| Name | Type | Description | Notes |
|---|---|---|---|
| source | [string] | The source of streaming connections to describe. Must be either `client` or `server`. | defaults to undefined |
| from | [string] | The series of data returned starts from this timestamp. Defaults to 24 hours ago. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp. Defaults to the current time. | (optional) defaults to undefined |
| tz | [string] | The timezone to use for breaks between days when returning daily data. | (optional) defaults to undefined |
| sdk | [string] | If included, this filters the returned series to only those that match this SDK name. | (optional) defaults to undefined |
| version | [string] | If included, this filters the returned series to only those that match this SDK version. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SdkVersionListRep getStreamUsageSdkversion()
Get a list of SDK version objects, which contain an SDK name and version. These are all of the SDKs that have connected to LaunchDarkly from your account in the past 60 days.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let source: string; //The source of streaming connections to describe. Must be either `client` or `server`. (default to undefined)
const { status, data } = await apiInstance.getStreamUsageSdkversion(
source
);| Name | Type | Description | Notes |
|---|---|---|---|
| source | [string] | The source of streaming connections to describe. Must be either `client` or `server`. | defaults to undefined |
SdkVersionListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | SDK Versions response | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SeriesListRep getVegaAIUsage()
Get time-series arrays of the number of Vega AI usage. Supports daily and monthly granularity.
import {
AccountUsageBetaApi,
Configuration
} from 'launchdarkly-api-typescript';
const configuration = new Configuration();
const apiInstance = new AccountUsageBetaApi(configuration);
let from: string; //The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. (optional) (default to undefined)
let to: string; //The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. (optional) (default to undefined)
let projectKey: string; //A project key to filter results by. Can be specified multiple times, one query parameter per project key. (optional) (default to undefined)
let granularity: 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. (optional) (default to undefined)
let aggregationType: string; //Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. (optional) (default to undefined)
const { status, data } = await apiInstance.getVegaAIUsage(
from,
to,
projectKey,
granularity,
aggregationType
);| Name | Type | Description | Notes |
|---|---|---|---|
| from | [string] | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | (optional) defaults to undefined |
| to | [string] | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | (optional) defaults to undefined |
| projectKey | [string] | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | (optional) defaults to undefined |
| granularity | [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. | (optional) defaults to undefined |
| aggregationType | [string] | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | (optional) defaults to undefined |
SeriesListRep
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Usage response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]