Contact statistics
The number of contacts matching the filters now, by status. Takes the same filters as list_contacts; call it for totals instead of walking the list. all is the sum of the three statuses. Deleted contacts are not counted. segment_id applies the conditions of the segment as they are now.
Request
- Base URLhttps://api.getsitecontrol.com
- AuthHTTP bearer
Path parameters
Query parameters
Any of these statuses; repeat for several. subscribed: subscribed, with double opt-in confirmed or not needed; unsubscribed: unsubscribed, never subscribed or awaiting double opt-in; bounced: the address bounced or failed the e-mail check
Tagged with any of these tag ids from list_tags; repeat for several
In any of these countries, ISO 3166-1 alpha-2 codes such as US; repeat for several
With any of these whole addresses, without case; repeat for several
Part of the e-mail, phone, first or last name, without case; % and _ are plain characters. Digits also match the id. To find a contact by its address, use email
created_at at or after this moment; without an offset, taken as UTC; a plain date means its start
created_at before this moment; without an offset, taken as UTC; a plain date means its start
updated_at at or after this moment; without an offset, taken as UTC; a plain date means its start. Only contacts with a recorded change match
Matching the conditions of this segment, a segment id from list_segments
Matching a tree of conditions, as JSON: the language of create_segment conditions, without saving a segment; for example contacts without a first name: {"op": "and", "args": [{"op": "undefined", "args": ["{{$contact.firstName}}"]}]}
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.