Skip to content

Retrieves call tracking numbers by site.

Retrieves call tracking numbers by site

Method get.ct_summary_report
Description Retrieves call tracking numbers by site.
Who has access Partners and clients

Request parameters

Name Type Required Valid values Description
access_token string yes Authentication session key
user_id number no Unique user identifier of the agent client on behalf of which the request is made (Is required for the agent) To obtain a list of client users, you must use the method ""get.customer_users""
limit number no Number of records returned. See section "Paging"
offset number no Shift determines from which record number to return "limit" records. Default is "0". See section "Paging"
filter object no See section "Filtering Criteria"
sort array no See section "Sorting data"
date_from iso8601 yes YYYY-MM-DD hh:mm:ss Start date and time of the reporting period.
date_till iso8601 yes YYYY-MM-DD hh:mm:ss Sampling end date

Response parameters

Name Type Valid values Filtering Sorting Default response Description
site_id number yes yes yes Unique site identifier
site_domain string yes yes yes Site domain
reserve_numbers_count number yes yes yes Number of numbers in reserve group
active_numbers_count number yes yes yes Number of numbers in all advertising campaigns on the site
dt_ratio number yes yes yes Coverage
non_session_calls_count number yes yes yes Number of calls without a session in blocks with dynamic call tracking for all advertising campaigns on the site
calls_count number yes yes yes Number of incoming calls in blocks with dynamic call tracking for all advertising campaigns on the site

Example request

{
"jsonrpc":"2.0",
"id":"number",
"method":"get.ct_summary_report",
"params":{
"access_token":"string",
"user_id":"number",
"offset":"number",
"limit":"number",
"date_from":"iso8601",
"date_till":"iso8601",
"filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]

}
}

Example response

{
"jsonrpc":"2.0",
"id":"number",
"result":{
"metadata":{

},
"data":[
{
"site_id": "number",
"dt_ratio": "number",
"calls_count": "number",
"site_domain": "number",
"active_numbers_count": "number",
"reserve_numbers_count": "number",
"non_session_calls_count": "number"
}
]
}
}

Possible errors

See the "Errors for get methods" section.