Skip to content

Files

Latest commit

author
LaunchDarklyReleaseBot
Version 17.2.0 automatically generated from ld-openapi.
Apr 4, 2025
912f2be · Apr 4, 2025

History

History
392 lines (284 loc) · 15.8 KB

MetricsBetaApi.md

File metadata and controls

392 lines (284 loc) · 15.8 KB

LaunchDarklyApi::MetricsBetaApi

All URIs are relative to https://app.launchdarkly.com

Method HTTP request Description
create_metric_group POST /api/v2/projects/{projectKey}/metric-groups Create metric group
delete_metric_group DELETE /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} Delete metric group
get_metric_group GET /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} Get metric group
get_metric_groups GET /api/v2/projects/{projectKey}/metric-groups List metric groups
patch_metric_group PATCH /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} Patch metric group

create_metric_group

create_metric_group(project_key, metric_group_post)

Create metric group

Create a new metric group in the specified project

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::MetricsBetaApi.new
project_key = 'project_key_example' # String | The project key
metric_group_post = LaunchDarklyApi::MetricGroupPost.new({key: 'metric-group-key-123abc', name: 'My metric group', kind: 'funnel', maintainer_id: '569fdeadbeef1644facecafe', tags: ["ops"], metrics: [LaunchDarklyApi::MetricInMetricGroupInput.new({key: 'metric-key-123abc', name_in_group: 'Step 1'})]}) # MetricGroupPost | 

begin
  # Create metric group
  result = api_instance.create_metric_group(project_key, metric_group_post)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling MetricsBetaApi->create_metric_group: #{e}"
end

Using the create_metric_group_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_metric_group_with_http_info(project_key, metric_group_post)

begin
  # Create metric group
  data, status_code, headers = api_instance.create_metric_group_with_http_info(project_key, metric_group_post)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MetricGroupRep>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling MetricsBetaApi->create_metric_group_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
project_key String The project key
metric_group_post MetricGroupPost

Return type

MetricGroupRep

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

delete_metric_group

delete_metric_group(project_key, metric_group_key)

Delete metric group

Delete a metric group by key.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::MetricsBetaApi.new
project_key = 'project_key_example' # String | The project key
metric_group_key = 'metric_group_key_example' # String | The metric group key

begin
  # Delete metric group
  api_instance.delete_metric_group(project_key, metric_group_key)
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling MetricsBetaApi->delete_metric_group: #{e}"
end

Using the delete_metric_group_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_metric_group_with_http_info(project_key, metric_group_key)

begin
  # Delete metric group
  data, status_code, headers = api_instance.delete_metric_group_with_http_info(project_key, metric_group_key)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling MetricsBetaApi->delete_metric_group_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
project_key String The project key
metric_group_key String The metric group key

Return type

nil (empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_metric_group

get_metric_group(project_key, metric_group_key, opts)

Get metric group

Get information for a single metric group from the specific project. ### Expanding the metric group response LaunchDarkly supports two fields for expanding the "Get metric group" response. By default, these fields are not included in the response. To expand the response, append the expand query parameter and add a comma-separated list with either or both of the following fields: - experiments includes all experiments from the specific project that use the metric group - experimentCount includes the number of experiments from the specific project that use the metric group For example, expand=experiments includes the experiments field in the response.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::MetricsBetaApi.new
project_key = 'project_key_example' # String | The project key
metric_group_key = 'metric_group_key_example' # String | The metric group key
opts = {
  expand: 'expand_example' # String | A comma-separated list of properties that can reveal additional information in the response.
}

begin
  # Get metric group
  result = api_instance.get_metric_group(project_key, metric_group_key, opts)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling MetricsBetaApi->get_metric_group: #{e}"
end

Using the get_metric_group_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_metric_group_with_http_info(project_key, metric_group_key, opts)

begin
  # Get metric group
  data, status_code, headers = api_instance.get_metric_group_with_http_info(project_key, metric_group_key, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MetricGroupRep>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling MetricsBetaApi->get_metric_group_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
project_key String The project key
metric_group_key String The metric group key
expand String A comma-separated list of properties that can reveal additional information in the response. [optional]

Return type

MetricGroupRep

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_metric_groups

get_metric_groups(project_key, opts)

List metric groups

Get a list of all metric groups for the specified project. ### Expanding the metric groups response LaunchDarkly supports one field for expanding the "Get metric groups" response. By default, these fields are not included in the response. To expand the response, append the expand query parameter and add a comma-separated list with the following field: - experiments includes all experiments from the specific project that use the metric group For example, expand=experiments includes the experiments field in the response. ### Filtering metric groups The filter parameter supports the following operators: contains, equals, anyOf. #### Supported fields and operators You can only filter certain fields in metrics when using the filter parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the filter parameter supports the following fields and operators: |<div style="width:120px">Field |Description |Supported operators | |---|---|---| | experimentStatus | The experiment's status. One of not_started, running, stopped, started. | equals | | hasConnections | Whether the metric group has connections to experiments or guarded rollouts. One of true, false. | equals | | kind | The metric group kind. One of funnel, standard. | equals | | maintainerIds | The metric maintainer IDs. | anyOf | | maintainerTeamKey | The metric maintainer team key. | equals | | query | A "fuzzy" search across metric group key and name. Supply a string or list of strings to the operator. | equals | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - name sorts by metric group name. - createdAt sorts by the creation date of the metric group. - connectionCount sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use - to sort in descending order. For example, ?sort=name sorts the response by metric group name in ascending order, and ?sort=-name sorts in descending order. #### Sample query filter=experimentStatus equals 'not_started' and query equals 'metric name'

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::MetricsBetaApi.new
project_key = 'project_key_example' # String | The project key
opts = {
  filter: 'filter_example', # String | Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`.
  sort: 'sort_example', # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields.
  expand: 'expand_example', # String | A comma-separated list of properties that can reveal additional information in the response.
  limit: 789, # Integer | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.
  offset: 789 # Integer | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items.
}

begin
  # List metric groups
  result = api_instance.get_metric_groups(project_key, opts)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling MetricsBetaApi->get_metric_groups: #{e}"
end

Using the get_metric_groups_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_metric_groups_with_http_info(project_key, opts)

begin
  # List metric groups
  data, status_code, headers = api_instance.get_metric_groups_with_http_info(project_key, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MetricGroupCollectionRep>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling MetricsBetaApi->get_metric_groups_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
project_key String The project key
filter String Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. [optional]
sort String A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. [optional]
expand String A comma-separated list of properties that can reveal additional information in the response. [optional]
limit Integer The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. [optional]
offset Integer Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. [optional]

Return type

MetricGroupCollectionRep

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

patch_metric_group

patch_metric_group(project_key, metric_group_key, patch_operation)

Patch metric group

Patch a metric group by key. Updating a metric group uses a JSON patch representation of the desired changes.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::MetricsBetaApi.new
project_key = 'project_key_example' # String | The project key
metric_group_key = 'metric_group_key_example' # String | The metric group key
patch_operation = [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField'})] # Array<PatchOperation> | 

begin
  # Patch metric group
  result = api_instance.patch_metric_group(project_key, metric_group_key, patch_operation)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling MetricsBetaApi->patch_metric_group: #{e}"
end

Using the patch_metric_group_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> patch_metric_group_with_http_info(project_key, metric_group_key, patch_operation)

begin
  # Patch metric group
  data, status_code, headers = api_instance.patch_metric_group_with_http_info(project_key, metric_group_key, patch_operation)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MetricGroupRep>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling MetricsBetaApi->patch_metric_group_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
project_key String The project key
metric_group_key String The metric group key
patch_operation Array<PatchOperation>

Return type

MetricGroupRep

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json