Pre-release — content may change.

Segments

List segment results

GET
/segment_filters/{id}/results

A cursor-paginated list of the segment filter's results. Each result records whether an entity was added to or removed from the segment. The 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.

page?

Cursor pagination parameters. Used by endpoints that paginate unbounded collections via before / after opaque cursors.

sort?string

Comma-separated sort fields, each optionally prefixed with - for descending order. Allowed fields: id, created_at, action. Defaults to -id.

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/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"      }    }  ],  "links": {    "prev": "/segment_filters/7247ad7d-9275-454b-9e3a-0570e403739e/results?page%5Bbefore%5D=WyJTRzEyMyJd&page%5Bsize%5D=25",    "next": "/segment_filters/7247ad7d-9275-454b-9e3a-0570e403739e/results?page%5Bafter%5D=WyJTRzQ1NiJd&page%5Bsize%5D=25"  },  "meta": {    "page": {      "before": "string",      "after": "string",      "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"      }    }  ]}