Получение отчета по сессиям звонков
Метод | get.campaign_daily_stat |
---|---|
Описание | Получение статистики РК по дням |
Кому доступен | Агент, Клиент |
Параметры запроса
Название | Тип | Обязательный | Допустимые значения | Описание |
---|---|---|---|---|
limit |
number | нет | Количество возвращаемых записей. См. раздел "Постраничный вывод" | |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
|
|
filter |
object | нет | См. раздел "Критерии фильтрации" | |
fields |
array | нет | См. раздел "Представление возвращаемых данных" | |
sort |
array | нет | См. раздел "Сортировка данных" | |
date_from |
iso8601 | да | YYYY-MM-DD hh:mm:ss | Дата начала выборки (ограничение 90 дней, как в стандартных методах отчетов) |
date_till |
iso8601 | да | YYYY-MM-DD hh:mm:ss | Дата окончания выборки |
site_id |
number | да | Идентификатор сайта в системе CoMagic |
Параметры ответа
Названия | Тип | Допустимые значения | Фильтрация | Сортировка | Ответ по умолчанию | Описани |
---|---|---|---|---|---|---|
date |
iso8601 | YYYY-MM-DD | да | да | да | День за который приведена статистика, ISO |
site_id |
number | да | да | Идентификатор сайта в системе CoMagic | ||
site_domain_name |
string | да | да | Доменное имя сайта | ||
campaign_id |
number | да | да | да | Идентификатор рекламной кампании в системе CoMagic | |
campaign_name |
string | да | да | Название рекламной кампании | ||
campaign_ext_id |
string |
да | да | да | Внешний идентификатор рекламной кампании | |
campaign_ext_name |
string |
да | да | да | Название внешней рекламной кампании | |
engine |
enum | yandex.direct, |
да | Система рекламной кампании | ||
banner_group_id |
string | да | да | |||
banner_group_name |
string | да | ||||
keyword_id |
string | да | да | Идентификатор ключевого слова в рекламной системе | ||
keyword |
string | да | Ключевое слово | |||
cost_sum |
string | да | Расходы на канал в данный день в валюте рекламной системы | |||
shows_count |
number | да | Показы для канала в данный день | |||
clicks_count |
number | да | Количество кликов по объявлению в данный день | |||
chats_count |
number | Количество чатов по рекламной кампании за день | ||||
calls_count |
number | Количество звонков по рекламной кампании за день | ||||
goals_count |
number | Количество целей по рекламной кампании за день | ||||
offline_messages_count |
number | Количество заявок с сайта по рекламной кампании за день | ||||
current_banner_id |
number | да | да | Текущий идентификатор объявления в рекламной системе | ||
old_banner_ids |
array | Предыдущие идентификаторы объявления в рекламной системе | ||||
visits_count |
number | Количество посещений в данный день | ||||
current_banner_name |
string | да | Название текущего банера в рекламной системе | |||
daily_budget |
number | да | Дневной бюджет | |||
weekly_budget |
number | да | Недельный бюджет | |||
currency |
enum | да | Валюта | |||
session_ids |
array | Список id сессий с этой РК за день | ||||
source_id |
number | Да | Да | Нет | Идентификатор источника | |
source_name |
string | Да | Да | Нет | Название источника | |
Список обращений | ||||||
communications |
array | Список обращений по этой РК за день | ||||
communication_type |
string | Тип обращения | ||||
communication_id |
number | id обращения | ||||
attributes |
array | Атрибуты обращения | ||||
Теги | ||||||
tags |
array | Теги на обращении | ||||
tag_id |
number | Уникальный идентификатор тега | ||||
tag_name |
string | Название тега | ||||
tag_type |
enum | auto, manual | Тип тега | |||
tag_change_time |
iso8601 | YYYY-MM-DD hh:mm:ss | Дата и время простановки тега | |||
tag_user_id |
number | Уникальный идентификатор пользователя, который проставил тег | ||||
tag_user_login | string | Логин пользователя, который проставил тег | ||||
tag_employee_id |
number | Уникальный идентификатор сотрудника, который проставил тег | ||||
tag_employee_full_name |
string | Ф.И.О. сотрудника который проставил тег |
JSON структора запроса
{
"id": "1",
"jsonrpc": "2.0",
"method": "get.campaign_daily_stat",
"params": {
"access_token": "string",
"user_id": "number",
"offset": "number",
"limit": "number",
"date_from": "iso8601",
"date_till": "iso8601",
"site_id" : "number",
"filter": {},
"sort": [
{
"field": "string",
"order": "string"
}
],
"fields": [
"string"
]
}
}
JSON структура ответа
{
"id": "1",
"jsonrpc": "2.0",
"result": [
{
"date": "iso8601",
"site_id": "number",
"site_domain_name": "string",
"campain_id": "number",
"campaign_name": "string",
"campaign_ext_id": "number",
"campaign_ext_name": "string",
"engine": "enum",
"banner_group_id": "number",
"banner_group_name": "string",
"keyword_id": "string",
"keyword": "string",
"banner_id": "number",
"banner_name": "string",
"old_banner_ids": [
"number"
],
"cost_sum": "string",
"shows_count": "number",
"clicks_count": "number",
"calls_count": "number",
"chats_count": "number",
"goals_count": "number",
"offline_messages_count": "number",
"source_id": "number",
"source_name": "string",
"session_ids": [
"number"
],
"daily_budget": "number",
"communications": [
{
"communication_type": "string",
"communication_id": "number",
"attributes": [
"string"
],
"tags": [
{
"tag_id": "number",
"tag_name": "string",
"tag_type": "enum",
"tag_change_time": "iso8601",
"tag_user_id": "number",
"tag_user_login": "string",
"tag_employee_id": "number",
"tag_employee_full": "string"
}
]
}
]
}
]
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"