Skip to content

Latest commit

 

History

History
128 lines (92 loc) · 6.6 KB

InsightsFlagEventsBetaApi.md

File metadata and controls

128 lines (92 loc) · 6.6 KB

launchdarkly_api.InsightsFlagEventsBetaApi

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

Method HTTP request Description
get_flag_events GET /api/v2/engineering-insights/flag-events List flag events

get_flag_events

FlagEventCollectionRep get_flag_events(project_key, environment_key, application_key=application_key, query=query, impact_size=impact_size, has_experiments=has_experiments, var_global=var_global, expand=expand, limit=limit, var_from=var_from, to=to, after=after, before=before)

List flag events

Get a list of flag events

Expanding the flag event collection response

LaunchDarkly supports expanding the flag event collection response to include additional fields.

To expand the response, append the expand query parameter and include the following:

  • experiments includes details on all of the experiments run on each flag

For example, use ?expand=experiments to include the experiments field in the response. By default, this field is not included in the response.

Example

  • Api Key Authentication (ApiKey):
import launchdarkly_api
from launchdarkly_api.models.flag_event_collection_rep import FlagEventCollectionRep
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.InsightsFlagEventsBetaApi(api_client)
    project_key = 'project_key_example' # str | The project key
    environment_key = 'environment_key_example' # str | The environment key
    application_key = 'application_key_example' # str | Comma separated list of application keys (optional)
    query = 'query_example' # str | Filter events by flag key (optional)
    impact_size = 'impact_size_example' # str | Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large` (optional)
    has_experiments = True # bool | Filter events to those associated with an experiment (`true`) or without an experiment (`false`) (optional)
    var_global = 'var_global_example' # str | Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` (optional)
    expand = 'expand_example' # str | Expand properties in response. Options: `experiments` (optional)
    limit = 56 # int | The number of deployments to return. Default is 20. Maximum allowed is 100. (optional)
    var_from = 56 # int | Unix timestamp in milliseconds. Default value is 7 days ago. (optional)
    to = 56 # int | Unix timestamp in milliseconds. Default value is now. (optional)
    after = 'after_example' # str | Identifier used for pagination (optional)
    before = 'before_example' # str | Identifier used for pagination (optional)

    try:
        # List flag events
        api_response = api_instance.get_flag_events(project_key, environment_key, application_key=application_key, query=query, impact_size=impact_size, has_experiments=has_experiments, var_global=var_global, expand=expand, limit=limit, var_from=var_from, to=to, after=after, before=before)
        print("The response of InsightsFlagEventsBetaApi->get_flag_events:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InsightsFlagEventsBetaApi->get_flag_events: %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]
query str Filter events by flag key [optional]
impact_size str Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large` [optional]
has_experiments bool Filter events to those associated with an experiment (`true`) or without an experiment (`false`) [optional]
var_global str Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` [optional]
expand str Expand properties in response. Options: `experiments` [optional]
limit int The number of deployments to return. Default is 20. Maximum allowed is 100. [optional]
var_from int Unix timestamp in milliseconds. Default value is 7 days ago. [optional]
to int Unix timestamp in milliseconds. Default value is now. [optional]
after str Identifier used for pagination [optional]
before str Identifier used for pagination [optional]

Return type

FlagEventCollectionRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Flag event collection 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]