/launchdarkly-usage | Type: Application | PCID required: Yes
Tools
launchdarkly_usage_create_announcement_public
Create an announcement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endTime | integer | No | — | The end time of the announcement. This is a Unix timestamp in milliseconds. |
isDismissible | boolean | Yes | — | true if the announcement is dismissible |
message | string | Yes | — | The message of the announcement |
severity | string | Yes | — | The severity of the announcement |
startTime | integer | Yes | — | The start time of the announcement. This is a Unix timestamp in milliseconds. |
title | string | Yes | — | The title of the announcement |
launchdarkly_usage_create_view
Create view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | Project Key |
description | string | No | — | Optional detailed description of the view |
generateSdkKeys | boolean | No | — | Whether to generate SDK keys for this view |
key | string | Yes | — | Unique key for the view within the account/project |
maintainerId | string | No | — | Member ID of the maintainer for this view. Only one of maintainerId or maintainerTeamKey can be specified. |
maintainerTeamKey | string | No | — | Key of the maintainer team for this view. Only one of maintainerId or maintainerTeamKey can be specified. |
name | string | Yes | — | Human-readable name for the view |
tags | string[] | No | — | Tags associated with this view |
launchdarkly_usage_delete_announcement_public
Delete an announcement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
announcementId | string | Yes | — | Announcement Id |
launchdarkly_usage_delete_application
Delete application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
applicationKey | string | Yes | — | The application key |
launchdarkly_usage_delete_application_version
Delete application version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
applicationKey | string | Yes | — | The application key |
versionKey | string | Yes | — | The application version key |
launchdarkly_usage_delete_view
Delete view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | Project Key |
viewKey | string | Yes | — | View Key |
launchdarkly_usage_get_announcements_public
Get announcements Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | Filter announcements by status. |
limit | integer | No | — | The number of announcements to return. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
launchdarkly_usage_get_application
Get application by key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
applicationKey | string | Yes | — | The application key |
expand | string | No | — | A comma-separated list of properties that can reveal additional information in the response. Options: flags. |
launchdarkly_usage_get_application_versions
Get application versions by application key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | string | No | — | Accepts filter by key, name, supported, and autoAdded. To learn more about the filter syntax, read Filtering applications and application versions. |
applicationKey | string | Yes | — | The application key |
limit | integer | No | — | The number of versions to return. Defaults to 50. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
sort | string | No | — | Accepts sorting order and fields. Fields can be comma separated. Possible fields are creationDate, name. Examples: sort=name sort by names ascending, sort=-name,creationDate sort by names descending and creationDate ascending. |
launchdarkly_usage_get_applications
Get applications Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | string | No | — | Accepts filter by key, name, kind, and autoAdded. To learn more about the filter syntax, read Filtering applications and application versions. |
limit | integer | No | — | The number of applications to return. Defaults to 10. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
sort | string | No | — | Accepts sorting order and fields. Fields can be comma separated. Possible fields are creationDate, name. Examples: sort=name sort by names ascending, sort=-name,creationDate sort by names descending and creationDate ascending. |
expand | string | No | — | A comma-separated list of properties that can reveal additional information in the response. Options: flags. |
launchdarkly_usage_get_audit_log_entries
List audit log entries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before | integer | No | — | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred before the timestamp. |
after | integer | No | — | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp. |
q | string | No | — | Text to search for. You can search for the full or partial name of the resource. |
limit | integer | No | — | A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. |
spec | string | No | — | A resource specifier that lets you filter audit log listings by resource |
launchdarkly_usage_get_audit_log_entry
Get audit log entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the audit log entry |
launchdarkly_usage_get_contexts_clientside_usage
Get contexts clientside usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
environmentKey | string | No | — | 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 | string | No | — | A context kind to filter results by. Can be specified multiple times, one query parameter per context kind. |
sdkName | string | No | — | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. |
anonymous | string | No | — | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: true, false. |
groupBy | string | No | — | 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 | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental, rolling_30d. |
granularity | string | No | — | 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. |
launchdarkly_usage_get_contexts_serverside_usage
Get contexts serverside usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
environmentKey | string | No | — | 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 | string | No | — | A context kind to filter results by. Can be specified multiple times, one query parameter per context kind. |
sdkName | string | No | — | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. |
anonymous | string | No | — | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: true, false. |
groupBy | string | No | — | 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 | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental, rolling_30d. |
granularity | string | No | — | 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. |
launchdarkly_usage_get_contexts_total_usage
Get contexts total usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
environmentKey | string | No | — | 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 | string | No | — | A context kind to filter results by. Can be specified multiple times, one query parameter per context kind. |
sdkName | string | No | — | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. |
sdkType | string | No | — | An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type. |
anonymous | string | No | — | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: true, false. |
groupBy | string | No | — | 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. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental, rolling_30d. |
granularity | string | No | — | 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. |
launchdarkly_usage_get_data_export_events_usage
Get data export events usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
environmentKey | string | No | — | 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. |
eventKind | string | No | — | An event kind to filter results by. Can be specified multiple times, one query parameter per event kind. |
groupBy | string | No | — | 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. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental. |
granularity | string | No | — | 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. |
launchdarkly_usage_get_evaluations_usage
Get evaluations usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
featureFlagKey | string | Yes | — | The feature flag key |
from | string | No | — | The series of data returned starts from this timestamp. Defaults to 30 days ago. |
to | string | No | — | The series of data returned ends at this timestamp. Defaults to the current time. |
tz | string | No | — | The timezone to use for breaks between days when returning daily data. |
launchdarkly_usage_get_events_usage
Get events usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | — | The type of event to retrieve. Must be either received or published. |
from | string | No | — | The series of data returned starts from this timestamp. Defaults to 24 hours ago. |
to | string | No | — | The series of data returned ends at this timestamp. Defaults to the current time. |
launchdarkly_usage_get_experimentation_events_usage
Get experimentation events usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
environmentKey | string | No | — | 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. |
eventKey | string | No | — | An event key to filter results by. Can be specified multiple times, one query parameter per event key. |
eventKind | string | No | — | An event kind to filter results by. Can be specified multiple times, one query parameter per event kind. |
groupBy | string | No | — | 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. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental. |
granularity | string | No | — | 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. |
launchdarkly_usage_get_experimentation_keys_usage
Get experimentation keys usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
environmentKey | string | No | — | 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. |
experimentId | string | No | — | An experiment ID to filter results by. Can be specified multiple times, one query parameter per experiment ID. |
groupBy | string | No | — | 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. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental. |
granularity | string | No | — | 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. |
launchdarkly_usage_get_linked_resources
Get linked resources Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | Project Key |
viewKey | string | Yes | — | View Key |
resourceType | string | Yes | — | Resource Type |
limit | integer | No | — | The number of views to return. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
sort | string | No | — | Field to sort by. Default field is linkedAt, default order is ascending. |
query | string | No | — | Case-insensitive search query for linked resources. Matches resource key and, when expanded, resource name. |
filter | string | No | — | Optional resource filter expression for linked resources. - Supported for flags and segments resource types. - Uses the same syntax as link/unlink and list endpoints. - For segments, environmentId is required when filter is provided. |
expand | string[] | No | — | A comma-separated list of fields to expand. |
launchdarkly_usage_get_linked_views
Get linked views for a given resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | Project Key |
resourceType | string | Yes | — | Resource Type |
resourceKey | string | Yes | — | Resource Key |
environmentId | string | No | — | Environment ID. Required when resourceType is ‘segments’ |
limit | integer | No | — | The number of views to return. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
launchdarkly_usage_get_mau_sdks_by_type
Get MAU SDKs by type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The data returned starts from this timestamp. Defaults to seven days ago. The timestamp is in Unix milliseconds, for example, 1656694800000. |
to | string | No | — | The data returned ends at this timestamp. Defaults to the current time. The timestamp is in Unix milliseconds, for example, 1657904400000. |
sdktype | string | No | — | The type of SDK with monthly active users (MAU) to list. Must be either client or server. |
launchdarkly_usage_get_mauclientside_usage
Get MAU clientside usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
environmentKey | string | No | — | 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. |
sdkName | string | No | — | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. |
anonymous | string | No | — | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: true, false. |
groupBy | string | No | — | 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. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental, rolling_30d. |
granularity | string | No | — | 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. |
launchdarkly_usage_get_mautotal_usage
Get MAU total usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
environmentKey | string | No | — | 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. |
sdkName | string | No | — | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. |
sdkType | string | No | — | An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type. |
anonymous | string | No | — | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: true, false. |
groupBy | string | No | — | 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. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental, rolling_30d. |
granularity | string | No | — | 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. |
launchdarkly_usage_get_observability_errors_usage
Get observability errors usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
granularity | string | No | — | 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. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental, rolling_30d. |
launchdarkly_usage_get_observability_logs_usage
Get observability logs usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
granularity | string | No | — | 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. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental, rolling_30d. |
launchdarkly_usage_get_observability_metrics_usage
Get observability metrics usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
granularity | string | No | — | Specifies the data granularity. Defaults to daily. Valid values depend on aggregationType: month_to_date supports hourly, daily, and monthly; average supports hourly, daily, and monthly. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, average. |
launchdarkly_usage_get_observability_sessions_usage
Get observability sessions usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
granularity | string | No | — | 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. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental, rolling_30d. |
launchdarkly_usage_get_observability_traces_usage
Get observability traces usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
granularity | string | No | — | 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. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental, rolling_30d. |
launchdarkly_usage_get_sdk_versions_details
Get SDK versions usage detailslaunchdarkly_usage_get_service_connections_usage
Get service connections usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
environmentKey | string | No | — | 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. |
connectionType | string | No | — | A connection type to filter results by. Can be specified multiple times, one query parameter per connection type. |
relayVersion | string | No | — | A relay version to filter results by. Can be specified multiple times, one query parameter per relay version. |
sdkName | string | No | — | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. |
sdkVersion | string | No | — | An SDK version to filter results by. Can be specified multiple times, one query parameter per SDK version. |
sdkType | string | No | — | An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type. |
sdkAppId | string | No | — | An SDK app ID to filter results by. Can be specified multiple times, one query parameter per SDK app ID. |
groupBy | string | No | — | 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, sdkAppId. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental. |
granularity | string | No | — | 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. |
launchdarkly_usage_get_stream_usage
Get stream usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source | string | Yes | — | The source of streaming connections to describe. Must be either client or server. |
from | string | No | — | The series of data returned starts from this timestamp. Defaults to 30 days ago. |
to | string | No | — | The series of data returned ends at this timestamp. Defaults to the current time. |
tz | string | No | — | The timezone to use for breaks between days when returning daily data. |
launchdarkly_usage_get_stream_usage_by_sdk_version
Get stream usage by SDK version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source | string | Yes | — | The source of streaming connections to describe. Must be either client or server. |
from | string | No | — | The series of data returned starts from this timestamp. Defaults to 24 hours ago. |
to | string | No | — | The series of data returned ends at this timestamp. Defaults to the current time. |
tz | string | No | — | The timezone to use for breaks between days when returning daily data. |
sdk | string | No | — | If included, this filters the returned series to only those that match this SDK name. |
version | string | No | — | If included, this filters the returned series to only those that match this SDK version. |
launchdarkly_usage_get_stream_usage_sdkversion
Get stream usage SDK versions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source | string | Yes | — | The source of streaming connections to describe. Must be either client or server. |
launchdarkly_usage_get_vega_aiusage
Get Vega AI usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. |
to | string | No | — | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. |
projectKey | string | No | — | A project key to filter results by. Can be specified multiple times, one query parameter per project key. |
granularity | string | No | — | 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. |
aggregationType | string | No | — | Specifies the aggregation method. Defaults to month_to_date.<br/>Valid values: month_to_date, incremental, rolling_30d. |
launchdarkly_usage_get_view
Get view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | Project Key |
viewKey | string | Yes | — | View Key |
sort | string | No | — | A sort to apply to the list of views. |
limit | integer | No | — | The number of views to return. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
filter | string | No | — | A filter to apply to the list of views. Supports the following fields and operators: name (equals, notEquals, startsWith, contains, anyOf), key (equals, notEquals, startsWith, contains, anyOf), tag (equals, anyOf), maintainerId (equals, anyOf), isPayloadView (equals). |
expand | string[] | No | — | A comma-separated list of fields to expand. |
launchdarkly_usage_get_views
List views Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | Project Key |
sort | string | No | — | A sort to apply to the list of views. |
limit | integer | No | — | The number of views to return. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
filter | string | No | — | A filter to apply to the list of views. Supports the following fields and operators: name (equals, notEquals, startsWith, contains, anyOf), key (equals, notEquals, startsWith, contains, anyOf), tag (equals, anyOf), maintainerId (equals, anyOf), isPayloadView (equals). |
expand | string[] | No | — | A comma-separated list of fields to expand. |
launchdarkly_usage_link_resource
Link resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | Project Key |
viewKey | string | Yes | — | View Key |
resourceType | string | Yes | — | Resource Type |
body | object | Yes | — | Resources to link to the view. You can provide explicit keys/IDs, filters, or both. - Flags: identified by key or filtered by maintainerId, maintainerTeamKey, tags, state, query - Segments: identified by segment ID or filtered by tags, query, unbounded |
launchdarkly_usage_patch_application
Update application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
applicationKey | string | Yes | — | The application key |
body | object[] | Yes | — | Request body |
launchdarkly_usage_patch_application_version
Update application version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
applicationKey | string | Yes | — | The application key |
versionKey | string | Yes | — | The application version key |
body | object[] | Yes | — | Request body |
launchdarkly_usage_post_audit_log_entries
Search audit log entries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before | integer | No | — | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred before the timestamp. |
after | integer | No | — | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred after the timestamp. |
q | string | No | — | Text to search for. You can search for the full or partial name of the resource. |
limit | integer | No | — | A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. |
body | object[] | No | — | Request body |
launchdarkly_usage_post_audit_log_entry_counts
Get audit log entry counts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before | integer | No | — | A timestamp filter, expressed as a Unix epoch time in milliseconds. Defaults to now. |
after | integer | Yes | — | A timestamp filter, expressed as a Unix epoch time in milliseconds. Required. |
buckets | integer | No | — | Number of time buckets to divide the range into. Default 50, max 500. |
body | object[] | Yes | — | Request body |
launchdarkly_usage_unlink_resource
Unlink resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | Project Key |
viewKey | string | Yes | — | View Key |
resourceType | string | Yes | — | Resource Type |
body | object | Yes | — | The resource to link to the view. Flags are identified by key. Segments are identified by segment ID. |
launchdarkly_usage_update_announcement_public
Update an announcement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
announcementId | string | Yes | — | Announcement Id |
body | object[] | Yes | — | Update announcement request body |
launchdarkly_usage_update_view
Update view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | Project Key |
viewKey | string | Yes | — | View Key |
archived | boolean | No | — | Whether or not the view is archived |
description | string | No | — | Optional detailed description of the view |
generateSdkKeys | boolean | No | — | Whether to generate SDK keys for this view |
maintainerId | string | No | — | Member ID of the maintainer for this view. Only one of maintainerId or maintainerTeamKey can be specified. |
maintainerTeamKey | string | No | — | Key of the maintainer team for this view. Only one of maintainerId or maintainerTeamKey can be specified. |
name | string | No | — | Human-readable name for the view |
tags | string[] | No | — | Tags associated with this view |

