Call tracking numbers for advertising campaigns
| Method | get.ct_ac_summary_report |
|---|---|
| Description | Call tracking numbers for advertising campaigns |
| Available to | Partner, Client |
Request parameters
| Title | 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 agentTo 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 | Sample start date |
date_till |
iso8601 | yes | YYYY-MM-DD hh:mm:ss | Sampling end date |
site_id |
number | yes | Unique site identifier |
Response parameters
| Name | Type | Valid values | Filtering | Sorting | Default response | Description |
|---|---|---|---|---|---|---|
ac_id |
number | yes | yes | Unique identifier advertising campaign | ||
ac_name |
string | yes | yes | yes | Advertising campaign name | |
is_reserve_pool |
boolean | yes | yes | yes | Campaign added to reserve group | |
is_dynamic |
boolean | yes | yes | Campaign with dynamic call tracking | ||
is_static |
boolean | yes | yes | Campaign with static call tracking | ||
active_numbers_count |
number | yes | yes | yes | Number of numbers in the advertising campaign | |
dt_ratio |
number | yes | yes | yes | Coverage | |
non_session_calls_count |
number | yes | yes | yes | Number of calls without a session in a block with dynamic call tracking | |
calls_count |
number | yes | yes | yes | Number of incoming calls in blocks with dynamic call tracking |
JSON request structure```json
{ "jsonrpc":"2.0", "id":"number", "method":"get.ct_ac_summary_report", "params":{ "access_token":"string", "user_id":"number", "offset":"number", "limit":"number", "date_from":"iso8601", "date_till":"iso8601", "site_id": "numder", "filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
} }
### JSON response structure```json
{
"jsonrpc":"2.0",
"id":"number",
"result":{
"metadata":{
},
"data":[
{
"ac_id": "number",
"ac_name": "string",
"dt_ratio": "number",
"is_static": "boolean",
"is_dynamic": "boolean",
"calls_count": "number",
"is_reserve_pool": "boolean",
"active_numbers_count": "number",
"non_session_calls_count": "number"
}
]
}
}
List of returned errors
See the section "List of errors for methods with the verb get"