launchdarkly_api.InsightsChartsBetaApi

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

Method	HTTP request	Description
get_deployment_frequency_chart	GET /api/v2/engineering-insights/charts/deployments/frequency	Get deployment frequency chart data
get_flag_status_chart	GET /api/v2/engineering-insights/charts/flags/status	Get flag status chart data
get_lead_time_chart	GET /api/v2/engineering-insights/charts/lead-time	Get lead time chart data
get_release_frequency_chart	GET /api/v2/engineering-insights/charts/releases/frequency	Get release frequency chart data
get_stale_flags_chart	GET /api/v2/engineering-insights/charts/flags/stale	Get stale flags chart data

get_deployment_frequency_chart

InsightsChart get_deployment_frequency_chart()

Get deployment frequency chart data

Get deployment frequency chart data. Engineering insights displays deployment frequency data in the deployment frequency metric view. ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the expand query parameter and include the following: * metrics includes details on the metrics related to deployment frequency For example, use ?expand=metrics to include the metrics field in the response. By default, this field is not included in the response.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import insights_charts_beta_api
from launchdarkly_api.model.validation_failed_error_rep import ValidationFailedErrorRep
from launchdarkly_api.model.insights_chart import InsightsChart
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
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'] = 'YOUR_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 = insights_charts_beta_api.InsightsChartsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key (optional)
    environment_key = "environmentKey_example" # str | The environment key (optional)
    application_key = "applicationKey_example" # str | Comma separated list of application keys (optional)
    _from = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Unix timestamp in milliseconds. Default value is 7 days ago. (optional)
    to = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Unix timestamp in milliseconds. Default value is now. (optional)
    bucket_type = "bucketType_example" # str | Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. (optional)
    bucket_ms = 1 # int | Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). (optional)
    group_by = "groupBy_example" # str | Options: `application`, `kind` (optional)
    expand = "expand_example" # str | Options: `metrics` (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get deployment frequency chart data
        api_response = api_instance.get_deployment_frequency_chart(project_key=project_key, environment_key=environment_key, application_key=application_key, _from=_from, to=to, bucket_type=bucket_type, bucket_ms=bucket_ms, group_by=group_by, expand=expand)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling InsightsChartsBetaApi->get_deployment_frequency_chart: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key	[optional]
environment_key	str	The environment key	[optional]
application_key	str	Comma separated list of application keys	[optional]
_from	datetime	Unix timestamp in milliseconds. Default value is 7 days ago.	[optional]
to	datetime	Unix timestamp in milliseconds. Default value is now.	[optional]
bucket_type	str	Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`.	[optional]
bucket_ms	int	Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds).	[optional]
group_by	str	Options: `application`, `kind`	[optional]
expand	str	Options: `metrics`	[optional]

Return type

InsightsChart

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Chart 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]

get_flag_status_chart

InsightsChart get_flag_status_chart(project_key, environment_key)

Get flag status chart data

Get flag status chart data. To learn more, read Using the flag status chart.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import insights_charts_beta_api
from launchdarkly_api.model.validation_failed_error_rep import ValidationFailedErrorRep
from launchdarkly_api.model.insights_chart import InsightsChart
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
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'] = 'YOUR_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 = insights_charts_beta_api.InsightsChartsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    application_key = "applicationKey_example" # str | Comma separated list of application keys (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get flag status chart data
        api_response = api_instance.get_flag_status_chart(project_key, environment_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling InsightsChartsBetaApi->get_flag_status_chart: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get flag status chart data
        api_response = api_instance.get_flag_status_chart(project_key, environment_key, application_key=application_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling InsightsChartsBetaApi->get_flag_status_chart: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key
application_key	str	Comma separated list of application keys	[optional]

Return type

InsightsChart

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Chart 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]

get_lead_time_chart

InsightsChart get_lead_time_chart(project_key)

Get lead time chart data

Get lead time chart data. The engineering insights UI displays lead time data in the lead time metric view.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import insights_charts_beta_api
from launchdarkly_api.model.validation_failed_error_rep import ValidationFailedErrorRep
from launchdarkly_api.model.insights_chart import InsightsChart
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
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'] = 'YOUR_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 = insights_charts_beta_api.InsightsChartsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key (optional)
    application_key = "applicationKey_example" # str | Comma separated list of application keys (optional)
    _from = 1 # int | Unix timestamp in milliseconds. Default value is 7 days ago. (optional)
    to = 1 # int | Unix timestamp in milliseconds. Default value is now. (optional)
    bucket_type = "bucketType_example" # str | Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. (optional)
    bucket_ms = 1 # int | Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). (optional)
    group_by = "groupBy_example" # str | Options: `application`, `stage`. Default: `stage`. (optional)
    expand = "expand_example" # str | Options: `metrics`, `percentiles`. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get lead time chart data
        api_response = api_instance.get_lead_time_chart(project_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling InsightsChartsBetaApi->get_lead_time_chart: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get lead time chart data
        api_response = api_instance.get_lead_time_chart(project_key, environment_key=environment_key, application_key=application_key, _from=_from, to=to, bucket_type=bucket_type, bucket_ms=bucket_ms, group_by=group_by, expand=expand)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling InsightsChartsBetaApi->get_lead_time_chart: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key	[optional]
application_key	str	Comma separated list of application keys	[optional]
_from	int	Unix timestamp in milliseconds. Default value is 7 days ago.	[optional]
to	int	Unix timestamp in milliseconds. Default value is now.	[optional]
bucket_type	str	Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`.	[optional]
bucket_ms	int	Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds).	[optional]
group_by	str	Options: `application`, `stage`. Default: `stage`.	[optional]
expand	str	Options: `metrics`, `percentiles`.	[optional]

Return type

InsightsChart

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Chart 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]

get_release_frequency_chart

InsightsChart get_release_frequency_chart(project_key, environment_key)

Get release frequency chart data

Get release frequency chart data. Engineering insights displays release frequency data in the release frequency metric view.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import insights_charts_beta_api
from launchdarkly_api.model.validation_failed_error_rep import ValidationFailedErrorRep
from launchdarkly_api.model.insights_chart import InsightsChart
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
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'] = 'YOUR_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 = insights_charts_beta_api.InsightsChartsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    application_key = "applicationKey_example" # str | Comma separated list of application keys (optional)
    has_experiments = True # bool | Filter events to those associated with an experiment (`true`) or without an experiment (`false`) (optional)
    _global = "global_example" # str | Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` (optional)
    group_by = "groupBy_example" # str | Property to group results by. Options: `impact` (optional)
    _from = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Unix timestamp in milliseconds. Default value is 7 days ago. (optional)
    to = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Unix timestamp in milliseconds. Default value is now. (optional)
    bucket_type = "bucketType_example" # str | Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. (optional)
    bucket_ms = 1 # int | Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). (optional)
    expand = "expand_example" # str | Options: `metrics` (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get release frequency chart data
        api_response = api_instance.get_release_frequency_chart(project_key, environment_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling InsightsChartsBetaApi->get_release_frequency_chart: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get release frequency chart data
        api_response = api_instance.get_release_frequency_chart(project_key, environment_key, application_key=application_key, has_experiments=has_experiments, _global=_global, group_by=group_by, _from=_from, to=to, bucket_type=bucket_type, bucket_ms=bucket_ms, expand=expand)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling InsightsChartsBetaApi->get_release_frequency_chart: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key
application_key	str	Comma separated list of application keys	[optional]
has_experiments	bool	Filter events to those associated with an experiment (`true`) or without an experiment (`false`)	[optional]
_global	str	Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude`	[optional]
group_by	str	Property to group results by. Options: `impact`	[optional]
_from	datetime	Unix timestamp in milliseconds. Default value is 7 days ago.	[optional]
to	datetime	Unix timestamp in milliseconds. Default value is now.	[optional]
bucket_type	str	Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`.	[optional]
bucket_ms	int	Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds).	[optional]
expand	str	Options: `metrics`	[optional]

Return type

InsightsChart

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Chart 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]

get_stale_flags_chart

InsightsChart get_stale_flags_chart(project_key, environment_key)

Get stale flags chart data

Get stale flags chart data. Engineering insights displays stale flags data in the flag health metric view. ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the expand query parameter and include the following: * metrics includes details on the metrics related to stale flags For example, use ?expand=metrics to include the metrics field in the response. By default, this field is not included in the response.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import insights_charts_beta_api
from launchdarkly_api.model.validation_failed_error_rep import ValidationFailedErrorRep
from launchdarkly_api.model.insights_chart import InsightsChart
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
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'] = 'YOUR_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 = insights_charts_beta_api.InsightsChartsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    application_key = "applicationKey_example" # str | Comma separated list of application keys (optional)
    group_by = "groupBy_example" # str | Property to group results by. Options: `maintainer` (optional)
    maintainer_id = "maintainerId_example" # str | Comma-separated list of individual maintainers to filter results. (optional)
    maintainer_team_key = "maintainerTeamKey_example" # str | Comma-separated list of team maintainer keys to filter results. (optional)
    expand = "expand_example" # str | Options: `metrics` (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get stale flags chart data
        api_response = api_instance.get_stale_flags_chart(project_key, environment_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling InsightsChartsBetaApi->get_stale_flags_chart: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get stale flags chart data
        api_response = api_instance.get_stale_flags_chart(project_key, environment_key, application_key=application_key, group_by=group_by, maintainer_id=maintainer_id, maintainer_team_key=maintainer_team_key, expand=expand)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling InsightsChartsBetaApi->get_stale_flags_chart: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key
application_key	str	Comma separated list of application keys	[optional]
group_by	str	Property to group results by. Options: `maintainer`	[optional]
maintainer_id	str	Comma-separated list of individual maintainers to filter results.	[optional]
maintainer_team_key	str	Comma-separated list of team maintainer keys to filter results.	[optional]
expand	str	Options: `metrics`	[optional]

Return type

InsightsChart

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Chart 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]

Files

InsightsChartsBetaApi.md

Latest commit

History

InsightsChartsBetaApi.md

File metadata and controls

launchdarkly_api.InsightsChartsBetaApi

get_deployment_frequency_chart

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_flag_status_chart

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_lead_time_chart

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_release_frequency_chart

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_stale_flags_chart

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details