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

MetricGroupRep create_metric_group(project_key, metric_group_post)

Create metric group

Create a new metric group in the specified project

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.metric_group_post import MetricGroupPost
from launchdarkly_api.models.metric_group_rep import MetricGroupRep
from launchdarkly_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = launchdarkly_api.MetricsBetaApi(api_client)
    project_key = 'project_key_example' # str | The project key
    metric_group_post = launchdarkly_api.MetricGroupPost() # MetricGroupPost | 

    try:
        # Create metric group
        api_response = api_instance.create_metric_group(project_key, metric_group_post)
        print("The response of MetricsBetaApi->create_metric_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetricsBetaApi->create_metric_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
metric_group_post	MetricGroupPost

Return type

MetricGroupRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Metric group response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_metric_group

delete_metric_group(project_key, metric_group_key)

Delete metric group

Delete a metric group by key.

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = launchdarkly_api.MetricsBetaApi(api_client)
    project_key = 'project_key_example' # str | The project key
    metric_group_key = 'metric_group_key_example' # str | The metric group key

    try:
        # Delete metric group
        api_instance.delete_metric_group(project_key, metric_group_key)
    except Exception as e:
        print("Exception when calling MetricsBetaApi->delete_metric_group: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Action succeeded	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_metric_group

MetricGroupRep get_metric_group(project_key, metric_group_key, expand=expand)

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.

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.metric_group_rep import MetricGroupRep
from launchdarkly_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = launchdarkly_api.MetricsBetaApi(api_client)
    project_key = 'project_key_example' # str | The project key
    metric_group_key = 'metric_group_key_example' # str | The metric group key
    expand = 'expand_example' # str | A comma-separated list of properties that can reveal additional information in the response. (optional)

    try:
        # Get metric group
        api_response = api_instance.get_metric_group(project_key, metric_group_key, expand=expand)
        print("The response of MetricsBetaApi->get_metric_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetricsBetaApi->get_metric_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
metric_group_key	str	The metric group key
expand	str	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

HTTP response details

Status code	Description	Response headers
200	Metric group response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_metric_groups

MetricGroupCollectionRep get_metric_groups(project_key, filter=filter, sort=sort, expand=expand, limit=limit, offset=offset)

List metric groups

Get a list of all metric groups for the specified project.

Expanding the metric groups response

This endpoint does not support response expansion.

Although the API accepts an expand query parameter for compatibility reasons, it does not currently modify the response. The parameter is reserved for future use.

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:

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'

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.metric_group_collection_rep import MetricGroupCollectionRep
from launchdarkly_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = launchdarkly_api.MetricsBetaApi(api_client)
    project_key = 'project_key_example' # str | The project key
    filter = 'filter_example' # str | Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. (optional)
    sort = 'sort_example' # str | 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 = 'expand_example' # str | This parameter is reserved for future use and is not currently supported on this endpoint. (optional)
    limit = 56 # int | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (optional)
    offset = 56 # int | 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)

    try:
        # List metric groups
        api_response = api_instance.get_metric_groups(project_key, filter=filter, sort=sort, expand=expand, limit=limit, offset=offset)
        print("The response of MetricsBetaApi->get_metric_groups:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetricsBetaApi->get_metric_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
filter	str	Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`.	[optional]
sort	str	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	str	This parameter is reserved for future use and is not currently supported on this endpoint.	[optional]
limit	int	The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.	[optional]
offset	int	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

HTTP response details

Status code	Description	Response headers
200	Metric group collection response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_metric_group

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

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.metric_group_rep import MetricGroupRep
from launchdarkly_api.models.patch_operation import PatchOperation
from launchdarkly_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = launchdarkly_api.MetricsBetaApi(api_client)
    project_key = 'project_key_example' # str | The project key
    metric_group_key = 'metric_group_key_example' # str | The metric group key
    patch_operation = [{"op":"replace","path":"/name","value":"my-updated-metric-group"}] # List[PatchOperation] | 

    try:
        # Patch metric group
        api_response = api_instance.patch_metric_group(project_key, metric_group_key, patch_operation)
        print("The response of MetricsBetaApi->patch_metric_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetricsBetaApi->patch_metric_group: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
metric_group_key	str	The metric group key
patch_operation	List[PatchOperation]

Return type

MetricGroupRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Metric group response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

MetricsBetaApi.md

Latest commit

History

MetricsBetaApi.md

File metadata and controls

launchdarkly_api.MetricsBetaApi

create_metric_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_metric_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_metric_group

Expanding the metric group response

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_metric_groups

Expanding the metric groups response

Filtering metric groups

Supported fields and operators

Sorting metric groups

Sample query

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_metric_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details