Segments
List processed segment results
A paginated list of the segment filter's current, added results (the processed membership). The serialized id is the result's public_id (a URL-safe Base64 string, not a UUID).
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Query Parameters
include?string
Comma-separated list of relationships to include. Allowed values are resource-specific; consult the operation for the allowlist.
sort?string
Comma-separated list of attributes to sort by. Prefix with - for
descending order (-created_at,family_name).
page?
Offset pagination parameters.
filter?
Supports filter[with_unassociated]=true to include results whose associated entity no longer exists, plus filter predicates on result attributes.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/segment_filters/497f6eca-6276-4993-bfeb-53cbbbba6f08/processed_results"{ "data": [ { "type": "segment_results", "id": "string", "attributes": { "action": "added", "created_at": "2019-08-24T14:15:22Z", "resource_name": "string" }, "relationships": { "resource": { "data": null, "links": { "self": "/segment_results/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/resource" } }, "segment_filter": { "data": null, "links": { "self": "/segment_results/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/segment_filter" } }, "links": {} }, "links": { "self": "/segment_results/7247ad7d-9275-454b-9e3a-0570e403739e" } } ], "meta": { "page": { "total_items": 0, "total_pages": 0, "number": 0, "size": 0 } }}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}