cURL
Analytics
Get Analytics Overview
Returns aggregated analytics metrics with growth rates compared to the previous period
GET
cURL
Returns aggregated analytics metrics with growth rates compared to the previous period. Use this endpoint to get a high-level summary of call performance including total calls, connected calls, conversations, meetings set, and follow-up tasks.
Query Parameters
- start_date (optional, date): Start date for the analytics period. Accepts ISO 8601 format. If omitted, defaults to 7 days before
end_date.- Examples:
2024-01-01T00:00:00.000Z- ISO 8601 with UTC timezone2024-01-01- Simple date format (YYYY-MM-DD)2024-01-01T00:00:00-05:00- ISO 8601 with timezone offset
- Examples:
- end_date (optional, date): End date for the analytics period. Accepts ISO 8601 format. If omitted, defaults to the current date.
- Examples:
2024-01-31T23:59:59.999Z- ISO 8601 with UTC timezone2024-01-31- Simple date format (YYYY-MM-DD)2024-01-31T23:59:59-05:00- ISO 8601 with timezone offset
- Examples:
- user_ids (optional, array of strings): Filter by specific user IDs.
- Example:
["64d2b3f2c4e3a6b8f2d9e1a7"]
- Example:
- disposition_ids (optional, array of numbers): Filter by disposition IDs (1=Meeting Set, 2=No Longer With Company, 3=Not Interested, etc.).
- Example:
[1, 2, 3]
- Example:
- timezone (optional, string): Timezone for date calculations.
- Example:
America/New_York
- Example:
Response
Each metric is returned as an object of the form{ "value": number, "growth_rate": number }, where growth_rate is the percentage change compared to the previous period of equal length.
Metrics included:
total_calls- Total number of calls madetotal_inbound_calls- Total number of inbound callsconnected_calls- Calls that connected (answered by human, disposition < 10)conversations- Connected calls with a meeting set or duration >= 60sconnection_rate-connected_calls / total_calls(percentage)conversation_rate-conversations / connected_calls(percentage)avg_calls_per_day- Average calls per active daytotal_call_duration- Total call duration in secondstotal_meetings_set- Calls with disposition ID = 1 (Meeting Set)total_follow_up_tasks- Number of follow-up tasks createdunique_contacts- Number of distinct contacts calledunique_companies- Number of distinct companies called
Authorizations
Query Parameters
Start date for the analytics period (ISO 8601). Examples: 2024-01-01, 2024-01-01T00:00:00.000Z, 2024-01-01T00:00:00-05:00. If omitted, defaults to 7 days before end_date.
End date for the analytics period (ISO 8601). Examples: 2024-01-31, 2024-01-31T23:59:59.999Z, 2024-01-31T23:59:59-05:00. If omitted, defaults to the current date.
Filter by specific user IDs
Filter by disposition IDs (1-14)
IANA timezone for date calculations (e.g., America/New_York)
Response
200 - application/json
Analytics overview retrieved successfully