LaunchDarkly Metric Import API Connector Setup Guide
This article describes how to set up the LaunchDarkly Metric Import API connector.
API Information
This connector uses the following vendor API:
- API Name: LaunchDarkly API
- API Version: v2
- API Endpoint:
https://events.launchdarkly.com
- Documentation: LaunchDarkly API
Batch Limits
This connector uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:
- Max number of requests: 10000
- Max time since oldest request: 10 minutes
- Max size of requests: 10 MB
Connector Actions
Action Name | AudienceStream | EventStream |
---|---|---|
Send Metrics to Experimentation Function | ✗ | ✓ |
Configure Settings
Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.
After adding the connector, configure the following settings:
- Company Name
Required. Name of your company in LaunchDarkly. - Project Key
Required. Project key for your metric events environment. Locate the project key in LaunchDarkly account settings > Projects > Environments. - Environment Key
Required. Environment key for the environment your metric events pertain to. Find these under Environments on the Projects tab in your LaunchDarkly Account settings page. - Access Token
Required. The access token must have a role that allows theimportEventData
action. LaunchDarkly strongly recommends using a dedicated access token with this permission. For more information, see Scoping Personal API Tokens and Environment Actions.
Actions
Enter a name for the action and select the action type from the drop-down menu.
The following section describes how to set up parameters and options for each action.
Send Metrics to Experimentation Function
Parameters
Parameter | Description |
---|---|
Key | Required. Identifies your metric. The Event Name in your LaunchDarkly metric must match this value. |
Creation Date | Timestamp of when the event is created, in Unix milliseconds. |
Metric Value | The value of your metric. Required for numeric metrics. Optional for conversion metrics. LaunchDarkly will ignore this value if provided for conversion metrics. |
Context Keys | A JSON object with one or more properties that lists the context keys for each metric event context in the format: <contextKind>: <contextKey> . For example, if your experiment works with user contexts, you may have the following kind/key pair: "user": "user-key-123abc" .Each context kind and key must match the kind/key pair in the corresponding context provided to LaunchDarkly SDK evaluating flags used in your experiments. For more information about using context kinds, see Randomization units. |
This page was last updated: May 17, 2024