Run Segmentation

Sorts a batch of records into your segments and returns the assignments inline. Synchronous: the call blocks until every record is assigned. Pass several configIds to apply several dimensions in one pass.

Unknown configIds are skipped, not rejected. A well-formed id that matches no existing config is silently ignored and the run proceeds on the remaining configs, so verify your ids against List Segment Configs rather than trusting a 200 to mean every dimension was applied.

Supply configIds (required, 1 to 10 segment config ids) and records (required, 1 to 25 records).

Returns 200 with per-record segment assignments inline. Returns 400 if configIds or records are missing or empty, if either exceeds its limit, if a configId is malformed (not a valid integer id), or if none of the supplied configIds match an existing config. Returns 5xx if the run fails before any record can be segmented; failures affecting individual records are reported per-record in the response.

This operation consumes credits for each record segmented. Config operations are free — only a run is billed.

Body Params

Segment run request with configuration IDs and records to process.

JSON API model for a segment run request.

data
object
required

The primary data of the document

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json