Contact

Get historical contact statistics

Retrieves statistics about the number of contacts in the project (total or in particular groups) over a date range. This endpoint returns historical data that is computed shortly after midnight each day in the project's time zone. If the date range includes the current day, it will include the current number of contacts.

To get historical statistics for the number of contacts matching a filter, use project.createGroup to create a dynamic group for each filter you want to track. However, the statistics will only be available for dates after the dynamic group was created.

get/v1/projects/{project_id}/contact_stats

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/contact_stats
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

Query parameters

start_datestring required

Start date of contact statistics, in YYYY-MM-DD format

end_datestring required

End date of contact statistics (inclusive), in YYYY-MM-DD format

rollup'day' | 'week' | 'month' | 'year'

Date interval to group by

cumulativeboolean

If true, each interval contains the total number of contacts at the end of the interval; if false, each interval contains the change in the number of contacts during the interval.

seriesstring

Comma separated list of up to 10 data series to return, corresponding to the keys of the values object in the response. Each item is either total (the total number of contacts in the project) or a group ID (the number of contacts in that group).

Response

Successful response

Changes

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