Skip to main content
GET
Get Call History Metrics

Headers

string
required
API key used for authenticating requests to the API.
string
required
Workspace identifier for the API.

Query Parameters

string
Filter metrics by a specific agent ID.
string
Filter by call status (e.g., “completed”, “failed”, “no-answer”).
string
Filter by call direction (“inbound”, “outbound”, “bidirectional”).
string
Filter by call flow ID.
string
JSON string with startDate and endDate in ISO format. Example: {"startDate":"2024-01-01","endDate":"2024-01-31"}
string
Filter by call type: “sip” or “web”.
Full-text search across caller name, phone numbers, and call ID. Accepts any phone format — +1 (845) 630-1653, 18456301653, or 8456301653 all match the same record.
string
Filter metrics to calls originating from a specific phone number. Non-digit characters are stripped automatically. Requires at least 7 digits.
string
Filter metrics to calls directed to a specific phone number. Same normalization as fromPhone.

Response Fields

number
Total number of calls matching the filters.
number
Number of completed calls.
number
Number of failed calls.
number
Average call duration in seconds.
number
Total cost of all calls.