Big Segments is an Enterprise feature
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. To learn more, read Big 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.
For a given context instance with attributes, get membership details for all segments
Context instance segment membership collection response
Invalid request
Invalid access token
Invalid resource identifier
{- "key": "context-key-123abc",
- "kind": "user",
- "moreComplex": {
- "morethanone": [
- 1,
- 2,
- 3
], - "yes": "please"
}, - "name": "Some User",
- "something": true
}
{- "items": [
- {
- "name": "Segment Name",
- "key": "segment-key-123abc",
- "description": "Segment description",
- "unbounded": false,
- "isMember": true,
- "isIndividuallyTargeted": true,
- "isRuleTargeted": false,
- "_links": {
- "property1": {
- "href": "string",
- "type": "string"
}, - "property2": {
- "href": "string",
- "type": "string"
}
}
}
], - "_links": {
- "property1": {
- "href": "string",
- "type": "string"
}, - "property2": {
- "href": "string",
- "type": "string"
}
}
}
Starts a new export process for a Big Segment
Action succeeded
Invalid request
Invalid access token
Invalid resource identifier
Rate limited
{- "code": "invalid_request",
- "message": "Invalid request body"
}
Returns info about a Big Segment export process.
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.
Import request submitted successfully
Invalid request
Invalid access token
Invalid resource identifier
Conflicting process
Rate limited
{- "code": "invalid_request",
- "message": "Invalid request body"
}
Returns info about a Big Segment import process.
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"
}
}
}