cURL
Analytics
Get List Performance
Returns call metrics grouped by contact list with pagination
GET
cURL
Returns call metrics grouped by contact list with pagination. Use this endpoint to analyze performance across different contact lists.
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:
- page (optional, number): Page number (default: 1).
- Example:
1
- Example:
- limit (optional, number): Items per page (default: 10, max: 100).
- Example:
10
- Example:
- search (optional, string): Search by list name.
- Example:
"sales"
- Example:
Response
Returns a paginated list of contact list performance metrics. Metrics per list:_id- Contact list IDname- Contact list namesource- List source (e.g., “csv”, “crm”)total_calls- Total calls made to contacts in this listconnected_calls- Connected callsconversations- Meaningful conversationsmeetings_set- Meetings set from this listgood_quality_contacts- Contacts with valid phone numbersdata_quality- Ratio of good quality contactsowner- List owner information (id, name, email)
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)
Page number
Required range:
x >= 1Items per page
Required range:
1 <= x <= 100Search by list name