Sign in
Dashboard

Get Calls

Get paginated, sorted, and filtered calls for the customer. By default, test calls are excluded.

get/dashboard/calls

Query parameters

pageinteger

Page number

Page number

page_sizeinteger

Number of items per page

Number of items per page

sort_columnstring

Column to sort by

Column to sort by

sort_directionstring

Sort direction

Sort direction

searchstring nullable

Search by phone number or caller name

Search by phone number or caller name

directionstring nullable

Filter by call direction

Filter by call direction

caller_client_statusstring nullable

Filter by caller client status

Filter by caller client status

has_errorboolean nullable

Filter by error status

Filter by error status

outcomestring nullable

Filter by call outcome

Filter by call outcome

vxt_transferstring nullable

Filter by VXT transfer outcome: answered, voicemail, no_answer, not_transferred

Filter by VXT transfer outcome: answered, voicemail, no_answer, not_transferred

dialtone_screeningstring nullable

Filter by dialtone screening outcome: accepted, declined, no_answer, none

Filter by dialtone screening outcome: accepted, declined, no_answer, none

sa_case_numberstring nullable

Filter to calls whose matched SmartAdvocate case number contains this text

Filter to calls whose matched SmartAdvocate case number contains this text

start_datetimestring date-time nullable

Filter calls with start_time >= this UTC datetime (inclusive)

Filter calls with start_time >= this UTC datetime (inclusive)

end_datetimestring date-time nullable

Filter calls with start_time < this UTC datetime (exclusive)

Filter calls with start_time < this UTC datetime (exclusive)

intakeboolean nullable

Filter by intake recording: true = only imported intake recordings (Intakes page), false = exclude them (Calls page), null = no filter

Filter by intake recording: true = only imported intake recordings (Intakes page), false = exclude them (Calls page), null = no filter

transfer_destinationstring uuid nullable

Filter to calls transferred to this TransferDestination (metrics drill-through; includes claimed bounce-back originals)

Filter to calls transferred to this TransferDestination (metrics drill-through; includes claimed bounce-back originals)

include_test_callsboolean

Include test calls in results

Include test calls in results

Response

Successful Response

totalinteger required
pageinteger required
page_sizeinteger required
total_pagesinteger required

Changes