get_result_set_by_id
Retrieve a segment's match-all result set by its segment and run IDs, checking readiness or error state.
Instructions
🟢 READ-ONLY · Segments · GET /api/3/segmentMatchAll/{segmentId}/{runId}
Return Match All result-set
Fetches data. Makes no changes to your ActiveCampaign account.
If the result-set is not ready yet, the response's is_ready attribute will be equal to false. The match-all request has errored out if the is_ready attribute is false and the run_id_end attribute contains a valid timestamp`; when this occurs please try your request again or alert the support team. If either the RunId or the SegmentId have expired or otherwise do not exist, a 404 with error details will be returned.
result-sets are cached and returned in the same sort order that's requ…
Input 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 |
| runId | Yes | A run id | |
| page_size | No | Page Size. Maximum: 10,000 | 20 |
| segmentId | Yes | segmentId |