Data Export destinations

Data Export is an add-on feature

Data Export is available as an add-on for customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.

Data Export provides a real-time export of raw analytics data, including feature flag requests, analytics events, custom events, and more.

Data Export Destinations are locations that receive exported data. The Data Export Destinations API allows you to configure destinations so that your data can be exported.

To learn more, read Data Export.

List destinations

Get a list of Data Export destinations configured across all projects and environments.

Request
Security:
ApiKey (readwrite)
Responses
200

Destination collection response

401

Invalid access token

403

Forbidden

429

Rate limited

get/api/v2/destinations
Request samples
curl -i -X GET \
  https://app.launchdarkly.com/api/v2/destinations \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "_links": {
    },
  • "items": [
    ]
}

Create data export destination

Create a new destination. The config body parameter represents the configuration parameters required for a destination type.

Request
Security:
ApiKey (readwrite)
path Parameters
projKey
required
string <string>

The project key

envKey
required
string <string>

The environment key

Request Body schema: application/json
name
string

A human-readable name for your data export destination.

kind
string
Enum: "google-pubsub" "kinesis" "mparticle" "segment" "azure-event-hubs"
config
any
on
boolean
Responses
201

Destination response

400

Invalid request

401

Invalid access token

403

Forbidden

409

Status conflict

429

Rate limited

post/api/v2/destinations/{projKey}/{envKey}
Request samples
application/json
{
  • "config": {
    },
  • "kind": "google-pubsub"
}
Response samples
    1 more
    429
application/json
{
  • "_id": "610addeadbeefaa86ec9a7d4",
  • "_links": {
    },
  • "name": "string",
  • "kind": "google-pubsub",
  • "version": 1,
  • "config": "{\"project\":\"test-prod\",\"topic\":\"ld-pubsub-test-192301\"}",
  • "on": true,
  • "_access": {
    }
}

Get destination

Get a single Data Export destination by ID

Request
Security:
ApiKey (readwrite)
path Parameters
projKey
required
string <string>

The project key

envKey
required
string <string>

The environment key

id
required
string <string>

The Data Export destination ID

Responses
200

Destination response

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/destinations/{projKey}/{envKey}/{id}
Request samples
curl -i -X GET \
  'https://app.launchdarkly.com/api/v2/destinations/{projKey}/{envKey}/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "_id": "610addeadbeefaa86ec9a7d4",
  • "_links": {
    },
  • "name": "string",
  • "kind": "google-pubsub",
  • "version": 1,
  • "config": "{\"project\":\"test-prod\",\"topic\":\"ld-pubsub-test-192301\"}",
  • "on": true,
  • "_access": {
    }
}

Update Data Export destination

Update a Data Export destination. This requires a JSON Patch representation of the modified destination.

Request
Security:
ApiKey (readwrite)
path Parameters
projKey
required
string <string>

The project key

envKey
required
string <string>

The environment key

id
required
string <string>

The Data Export destination ID

Request Body schema: application/json
Array
op
required
string

The type of operation to perform

path
required
string

A JSON Pointer string specifying the part of the document to operate on

value
required
any

A JSON value used in "add", "replace", and "test" operations

Responses
200

Destination response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

409

Status conflict

429

Rate limited

patch/api/v2/destinations/{projKey}/{envKey}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
    2 more
    409
    429
application/json
{
  • "_id": "610addeadbeefaa86ec9a7d4",
  • "_links": {
    },
  • "name": "string",
  • "kind": "google-pubsub",
  • "version": 1,
  • "config": "{\"project\":\"test-prod\",\"topic\":\"ld-pubsub-test-192301\"}",
  • "on": true,
  • "_access": {
    }
}

Delete Data Export destination

Delete Data Export destination by ID

Request
Security:
ApiKey (readwrite)
path Parameters
projKey
required
string <string>

The project key

envKey
required
string <string>

The environment key

id
required
string <string>

The Data Export destination ID

Responses
204

Destination response

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

delete/api/v2/destinations/{projKey}/{envKey}/{id}
Request samples
curl -i -X DELETE \
  'https://app.launchdarkly.com/api/v2/destinations/{projKey}/{envKey}/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "code": "unauthorized",
  • "message": "invalid key"
}
➔ Next to Environments