Номера колтрекинга по рекламным кампаниям
Номера колтрекинга по рекламным кампаниям
Метод | get.ct_ac_summary_report |
---|---|
Описание | Номера колтрекинга по рекламным кампаниям |
Кому доступен | Партнер, Клиент |
Параметры запроса
Название | Тип | Обязательный | Допустимые значения | Описание |
---|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации | |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
|
limit |
number | нет | Количество возвращаемых записей. См. раздел "Постраничный вывод" | |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
|
|
filter |
object | нет | См. раздел "Критерии фильтрации" | |
fields |
array | нет | См. раздел "Представление возвращаемых данных" | |
sort |
array | нет | См. раздел "Сортировка данных" | |
date_from |
iso8601 | да | YYYY-MM-DD hh:mm:ss | Дата начала выборки |
date_till |
iso8601 | да | YYYY-MM-DD hh:mm:ss | Дата окончания выборки |
site_id |
number | да | Уникальный идентификатор сайта |
Параметры ответа
Название | Тип | Допустимые значения | Фильтрация | Сортировка | Ответ по умолчанию | Описание |
---|---|---|---|---|---|---|
ac_id |
number | да | да | Уникальный идентификатор рекламной кампании | ||
ac_name |
string | да | да | да | Имя рекламной кампании | |
is_reserve_pool |
boolean | да | да | да | Кампания добавлена в резервную группу | |
is_dynamic |
boolean | да | да | Кампания с динамическим коллтрекингом | ||
is_static |
boolean | да | да | Кампания со статическим коллтрекингом | ||
active_numbers_count |
number | да | да | да | Число номеров в рекламной кампании | |
dt_ratio |
number | да | да | да | Охват | |
non_session_calls_count |
number | да | да | да | Количество звонков без сессии в блоке с динамическим коллтрекингом | |
calls_count |
number | да | да | да | Количество входящих звонков в блоках с динамическим коллтрекингом |
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 структура ответа
{
"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"
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"