create_match_all_request_with_segment_id
Read-onlyIdempotent
Starts a match-all request for a given segment to find all contacts matching its criteria. Returns results if ready within 4 seconds, otherwise provides a runId to check later.
Instructions
🟢 READ-ONLY · query · Segments · GET /api/3/segmentMatchAll/{segmentId}
Create a Match All Request
Runs a search/report (a POST that returns data). Changes no account records; may create a short-lived, cached result-set.
A new match-all request will be initiated. If results are not ready within 4 seconds, a response that lacks a result-set will be returned and the response's is_ready attribute will be equal to false. Use the returned segmentId and runId to poll and check back later to see if the result-set is ready
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page Number | 1 |
| sort | No | Comma delimited list of fields for which to sort the results. Optionally prepended with a dash sign to indicate descending order. Allowed fields: id, email, phone, first_name, last_name, full_name, cdate, udate, account_name, score, score<score-id>. The score<score-id> option will sort off of the value of a particular score. Examples: "email", "-phone", "score2", "last_name,-first_name" | id |
| instant | No | If present, API will return instantly with a runId without waiting for up to 4 seconds for the results to be ready. Useful if you want to kick off a match-all request but don't need the results immediately | |
| page_size | No | Page Size. Maximum: 10,000 | 20 |
| segmentId | Yes | A segment id |