Skip to main content
Getting Calls & Reports via API

Getting a list of calls via API from Speed To Lead

Updated over a week ago

To get a list of corresponding webhooks, you need to send a GET request to the following endpoint:

Note: You can find the API key by clicking here.

List of Parameters

date_from

The start date of the period (in YYYY-MM-DD format) for which call data will be retrieved, default is 30 days before the current date

date_to

The end date of the period (in YYYY-MM-DD format) for which call data will be retrieved, default is the current date

widget_ids

Comma-separated IDs of the widgets for which data will be retrieved

max_calls

The number of calls for which data will be retrieved (default is 20, maximum is 500)

page

Used for pagination, indicates which page of the call list data will be shown, default is 1

search_string

If this parameter is present, data will be retrieved only for calls where at least one of the following fields partially or fully matches the search string: call ID, agent name, widget URL, widget name, agent or lead comment, one of the additional parameters (custom_params), lead phone number, agent phone number

status

For missed calls - CallStatusType. NO_ANSWER, For calls not answered by the lead - CallStatusType.OPERATOR_ANSWERED, For calls answered by both the agent and the lead - CallStatusType.CLIENT_ANSWERED

filter_url

Filter by widget URL

filter_referer

Filter by advertising campaign source (referer field)

filter_lead_number

Filter by lead phone number

filter_agent

Filter by agent name or phone number

filter_answer_time_from

Retrieve data only for calls where the agent answer time is greater than the specified value (in seconds)

filter_answer_time_to

Retrieve data only for calls where the agent answer time is less than the specified value (in seconds)

filter_talk_time_from

Retrieve data only for calls where the agent and lead talk time is greater than the specified value (in seconds)

filter_talk_time_to

Retrieve data only for calls where the agent and lead talk time is less than the specified value (in seconds)

Example of a successful response:

Includes 3 main parameters: "success", "endCallPayloadList" and "data".

  • "success" - If the response is delivered, it will always be "true".

  • "endCallPayloadList" - list of call data.

  • "data" - overall call statistics in endCallPayloadList.

{
"success": true,
"endCallPayloadList": [
{
"type": "end_call",
"call_id": "ea5cb446b310dc4a372cc569e6f20f4c",
"user_id": 70519,
"widget_key": "13fc906a55865f5b86b2d1239573353b",
"widget_name": "Arthur Else Test",
"call_status": "answered",
"timezone": "Asia/Dubai",
"time_started_iso_string": "2023-01-20T07:49:38.000Z",
"time_agent_answered_iso_string": "2023-01-20T07:49:49.000Z",
"time_lead_answered_iso_string": "2023-01-20T07:49:49.000Z",
"time_ended_iso_string": "2023-01-20T07:49:55.000Z",
"is_delayed_call": false,
"answer_duration_sec": 11,
"lead_answer_duration_sec": 0,
"talk_duration_sec": 6,
"total_duration_sec": 17,
"disconnected_by": "lead",
"recording_link": "<https://app.convolo.ai/records/94db4e857bec9cb857ff70e166ca4832.mp3>",
"called_lead_phone": "46766921412",
"agent": {
"id": null,
"phone": "46766921409",
"name": "TestArthur",
"email": null
},
"lead": {
"lead_phone": "46766921412",
"lead_id": "01GQ727HX1ET0FTW7J58KFXNS3",
"time_created_iso_string": "2023-01-20T07:49:38.150Z",
"source": "client called back",
"site_path": "client called back",
"referer": "",
"ip": "",
"country": "SE",
"additional": {
"original_call_id": "0ca70941979ab9b495f39a1ab23f10c",
"number_country_eng": "Sweden"
},
"custom_params": {
"original_call_id": "0ca70941979ab9b495f39a1ab23f10c",
"lc_param_page_title": "React App"
}
}
},
.....
],
"data": {
"calls_total": 45,
"calls_answered": 36,
"calls_no_answer": 1,
"calls_missed": 8,
"date_from": "2022-12-12T00:00:00.000Z",
"date_to": "2023-02-20T23:59:59.999Z",
"min_agent_answer_time": 7,
"max_agent_answer_time": 44,
"min_talk_time": 5,
"max_talk_time": 61
}
}

Data parameters

calls_total

Total number of calls matching the selection criteria

calls_answered

Number of answered calls

calls_no_answer

Number of calls not answered by the lead

calls_missed

Number of calls missed by agents

date_from

Start of the period in which the calls were made

date_to

End of the period in which the calls were made

min_agent_answer_time

Minimum time for an agent to answer a call (in seconds)

max_agent_answer_time

Maximum time for an agent to answer a call (in seconds)

min_talk_time

Minimum duration of a conversation (in seconds)

max_talk_time

Maximum duration of a conversation (in seconds)

Did this answer your question?