Big Segments is an Enterprise feature
This section documents endpoints for rule-based, list-based, and synced segments.
A Big Segment is a segment that is either a synced segment, or a list-based segment with more than 15,000 entries that includes only one targeted context kind. LaunchDarkly uses different implementations for different types of segments so that all of your segments have good performance.
In the segments API, a Big Segment is indicated by the
unbounded
field being set totrue
.Big Segments is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.
This feature is in beta
To use this feature, pass in a header including the
LD-API-Version
key with value set tobeta
. Use this header with each call. To learn more, read Beta resources.Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible.
The segments API allows you to create and retrieve exports and imports for Big Segments, that is, list-based segments with 15,000 or more entries. To learn more, read List-based segments.
Several of the endpoints in the segments API require an import or export ID. The import ID is returned in the Location
header as part of the Create Big Segment import request. The export ID is returned in the Location
header as part of the Create Big Segment export request. In each case, the ID is the final element of the path returned in the Location
header.
Starts a new export process for a Big Segment. This is an export for a list-based segment that can include more than 15,000 entries.
Action succeeded
Invalid request
Invalid access token
Invalid resource identifier
Rate limited
{- "code": "invalid_request",
- "message": "Invalid request body"
}
Returns information about a Big Segment export process. This is the export of a list-based segment that can include more than 15,000 entries.
Segment export response
Invalid request
Invalid resource identifier
Rate limited
{- "id": "1234a567-bcd8-9123-4567-abcd1234567f",
- "segmentKey": "example-big-segment",
- "creationTime": 0,
- "status": "complete",
- "sizeBytes": 18,
- "size": "18 B",
- "initiator": {
- "name": "Bob Loblaw",
- "email": "ariel@acme.com"
}, - "_links": {
- "property1": {
- "href": "string",
- "type": "string"
}, - "property2": {
- "href": "string",
- "type": "string"
}
}
}
Start a new import process for a Big Segment. This is an import for a list-based segment that can include more than 15,000 entries.
Import request submitted successfully
Invalid request
Invalid access token
Invalid resource identifier
Conflicting process
Rate limited
{- "code": "invalid_request",
- "message": "Invalid request body"
}
Returns information about a Big Segment import process. This is the import of a list-based segment that can include more than 15,000 entries.
Segment import response
Invalid request
Invalid resource identifier
Rate limited
{- "id": "1234a567-bcd8-9123-4567-abcd1234567f",
- "segmentKey": "example-big-segment",
- "creationTime": 0,
- "mode": "replace",
- "status": "complete",
- "files": [
- {
- "filename": "bigsegimport.csv",
- "status": "complete"
}
], - "_links": {
- "property1": {
- "href": "string",
- "type": "string"
}, - "property2": {
- "href": "string",
- "type": "string"
}
}
}