sequences

Count the contacts a filter matches under each tab

How the contacts matching a search or filter split across the Audience tab's tabs (In progress, Needs approval, Paused, Done, Blocked), judged as list_sequence_contacts' 'group' lists them under the same filters, so each count is the length of that tab's filtered list. 'total' counts every match; 'capped' says more contacts match than one read judges. The page's tabs read it while its search box or a filter is on; get_audience_eligibility counts the whole roster.

get/sequences/{sequence_id}/contacts/groups/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

sequence_idstring uuid required

Query parameters

statusesEnrolmentStatus[] nullable
stop_reasonsStopReason[] nullable
excludeboolean
searchstring nullable
created_fromstring date-time nullable
created_tostring date-time nullable

Response

Successful Response

cappedboolean required

More contacts match than one read judges, so each tab's count is at least that many.

totalinteger required

Every contact the filters match: the All tab's count.

Changes

No recorded changes to this operation across all 1 revision of this API.