Table of Contents:
Table of Contents minLevel 2
Note: Notice that in each API call you must provide the List ID that you are working on, otherwise the default List ID will be used.
Methods Summary
GET /api/contact_counts/<id>
Description
- This method provides a count for specific Count ID.
- In order to get get a Count Id, first use POST /api/contact_counts method as detailed in the next section.
...
Error Codes
- 404 - Not found
POST /api/contact_counts
Description
Initiate a count process, typically used to get the latest count for a Segment but can also be done on a criteria.
- This method returns a Count ID in response.
Use You will need the Count ID received returned from this POST request, in the GET method above, in order to get the number count of contacts for the segment/criteria provided in this POST requestthe POST request.
- Some users might only want to issue a count, so the latest segment count will be seen in the Ongage UI, in which case there's no need to save the Count ID, nor use the GET command.
Request
segment_id
Required (only when criteria is empty) int
...
- 404 - Not found
- 500 - Validation error
Segment Count Example
Segment Count Post Example
...