LaunchDarklyApi.AccountUsageBetaApi

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

getContextsClientsideUsage

SeriesListRep getContextsClientsideUsage(opts)

Get contexts clientside 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. The counts reflect data reported by client-side SDKs. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AccountUsageBetaApi();
let opts = {
  'from': "from_example", // String | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
  'to': "to_example", // String | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
  'projectKey': "projectKey_example", // String | A project key to filter results by. Can be specified multiple times, one query parameter per project key.
  'environmentKey': "environmentKey_example", // 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.
  'contextKind': "contextKind_example", // String | A context kind to filter results by. Can be specified multiple times, one query parameter per context kind.
  'sdkName': "sdkName_example", // String | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
  'anonymous': "anonymous_example", // String | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`.
  'groupBy': "groupBy_example", // 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`.
  'aggregationType': "aggregationType_example", // String | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`.
  'granularity': "granularity_example" // 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.
};
apiInstance.getContextsClientsideUsage(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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]
to	String	The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.	[optional]
projectKey	String	A project key to filter results by. Can be specified multiple times, one query parameter per project key.	[optional]
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]
contextKind	String	A context kind to filter results by. Can be specified multiple times, one query parameter per context kind.	[optional]
sdkName	String	An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.	[optional]
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]
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]
aggregationType	String	Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`.	[optional]
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]

Name	Type	Description	Notes
projectKey	String	The project key
environmentKey	String	The environment key
featureFlagKey	String	The feature flag key
from	String	The series of data returned starts from this timestamp. Defaults to 30 days ago.	[optional]
to	String	The series of data returned ends at this timestamp. Defaults to the current time.	[optional]
tz	String	The timezone to use for breaks between days when returning daily data.	[optional]

Name	Type	Description	Notes
type	String	The type of event to retrieve. Must be either `received` or `published`.
from	String	The series of data returned starts from this timestamp. Defaults to 24 hours ago.	[optional]
to	String	The series of data returned ends at this timestamp. Defaults to the current time.	[optional]

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]
to	String	The data returned ends at this timestamp. Defaults to the current time. The timestamp is in Unix milliseconds, for example, 1657904400000.	[optional]
sdktype	String	The type of SDK with monthly active users (MAU) to list. Must be either `client` or `server`.	[optional]

Name	Type	Description	Notes
source	String	The source of streaming connections to describe. Must be either `client` or `server`.
from	String	The series of data returned starts from this timestamp. Defaults to 30 days ago.	[optional]
to	String	The series of data returned ends at this timestamp. Defaults to the current time.	[optional]
tz	String	The timezone to use for breaks between days when returning daily data.	[optional]

FilesExpand file tree

AccountUsageBetaApi.md

Latest commit

History

AccountUsageBetaApi.md

File metadata and controls

LaunchDarklyApi.AccountUsageBetaApi

getContextsClientsideUsage

Example

Parameters

Return type

Authorization

HTTP request headers

getContextsServersideUsage

Example

Parameters

Return type

Authorization

HTTP request headers

getContextsTotalUsage

Example

Parameters

Return type

Authorization

HTTP request headers

getDataExportEventsUsage

Example

Parameters

Return type

Authorization

HTTP request headers

getEvaluationsUsage

Example

Parameters

Return type

Authorization

HTTP request headers

getEventsUsage

Example

Parameters

Return type

Authorization

HTTP request headers

getExperimentationEventsUsage

Example

Parameters

Return type

Authorization

HTTP request headers

getExperimentationKeysUsage

Example

Parameters

Return type

Authorization

HTTP request headers

getMAUClientsideUsage

Example

Parameters

Return type

Authorization

HTTP request headers

getMAUTotalUsage

Example

Parameters

Return type

Authorization

HTTP request headers

getMauSdksByType

Example

Parameters

Return type

Authorization

HTTP request headers

getMauUsage

Example

Parameters

Return type

Authorization

HTTP request headers

getMauUsageByCategory