Отчет "Посещения". Получение списка всех посещений за 31 день
| Метод | get.visits |
|---|---|
| Описание | Получение списка всех посещений за 31 день |
| Кому доступен | Агент, Клиент |
| Необходимые компоненты для работы с методом | Data API для настройки |
| Вес метода | 1 балл |
Параметры запроса
| Название | Тип | Обязательный | Допустимые значения | Описание |
|---|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации | |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
|
limit |
number | нет | Количество возвращаемых записей. См. раздел "Постраничный вывод" | |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод" | |
report_id |
number | да | Уникальный идентификатор отчета пользователя. Для получения списка отчетов пользователей необходимо использовать метод "get.reports_list" | |
date_from |
iso8601 | да | YYYY-MM-DD hh:mm:ss | Дата начала основной выборки(ограничение в 31 день) |
date_till |
iso8601 | да | YYYY-MM-DD hh:mm:ss | Дата окончания основной выборки |
is_realtime |
boolean | да | Является ли запрашиваемый отчет, отчетом за последние 30 минут. Признак отчета реалтайм. | |
fields |
array | нет | Список идентификаторов пользовательских столбцов, разделенных запятой. Доступный список столбцов см.раздел "Получение вложенности столбцов" . Порядок влияет на ответ. | |
| Фильтры применяемые в отчете | filter |
object | нет | Допустимо использовать не более 2 уровней вложенности. Смотри примеры ниже |
Фильтры применяемые в отчете. Логика построения аналогична "Критерии фильтрации" |
filters |
array | да | Выражение, может содержать в себе как простые фильтры, так и дерево фильтров. Доступный список фильтров для отчета с их возможными значениями см.раздел "Получение списка возможных условий фильтрации для отчета" . | |
field |
string | Поле сущности к которой будет применяться фильтрация (список заранее определен для метода) | ||
operator |
enum | Оператор фильтрации. Список всех операторов можно получить в разделе "Операторы фильтрации" | ||
value |
string | Значение для оператора фильтрации. Необязательное поле, если оно отсутствует, то считается пустота. | ||
| Сортировка применяемая в отчете | sort |
array | нет | Сортировка применяемая в отчете. Логика построения аналогична "Сортировка данных" |
Параметры ответа
| Название | Тип | Допустимые значения | Фильтрация | Сортировка | Ответ по умолчанию | Описание |
|---|---|---|---|---|---|---|
site_domain_name |
string | да | да | да |
Адрес сайта в интернете. Без указания протокола - "http://" или "https://"
|
|
site_domain_naked |
string | да | да | да | Основной домен адреса сайта в интернете. | |
| Рекламные системы | ||||||
pc |
string | да | да | да | Название внешней рекламной кампании | |
pc_ext_id |
string | да | да | да | Внешний идентификатор внешней рекламной кампании | |
gr |
string | да | да | да | Название группы объявлений | |
gr_ext_id |
string | да | да | да | Внешний идентификатор группы объявлений | |
ad |
string | да | да | да | Название объявления | |
ad_ext_ids |
string | да | да | да | Внешний идентификатор объявления. Может содержать в себе несколько внешних id объявлений. | |
kw |
string | да | да | да | Ключевое слово | |
kw_ext_id |
string | да | да | да | Внешний идентификатор ключевого слова. | |
| Источники трафика | ||||||
campaign_name |
string | да | да | да | Название рекламной кампании | |
channel_new |
string | да | да | да | Канал(new). Название канала источника | |
channel_code |
string | да | да | да | Мнемоника канала | |
source_new |
string | да | да | да | Источник(new). Группа источника | |
source_name |
string | да | да | да | Источник(детальный). Название источника | |
channel |
string | да | да | Канал. | ||
source |
string | да | да | Источник. | ||
referrer |
string | да | да | Источник перехода | ||
referrer_domain |
string | да | да | Домен реферера | ||
search_query |
string | да | да | Поисковый запрос | ||
| Метки UTM | ||||||
utm_source |
string | да | да | UTM-метка Source | ||
utm_medium |
string | да | да | UTM-метка Medium | ||
utm_term |
string | да | да | UTM-метка Term | ||
utm_content |
string | да | да | UTM-метка Content | ||
utm_campaign |
string | да | да | UTM-метка Campaign | ||
utm_referrer |
string | да | да | UTM-метка Referrer | ||
utm_expid |
string | да | да | UTM-метка Expid | ||
| Метки Openstat | ||||||
openstat_ad |
string | да | да | Идентификатор рекламного объявления | ||
openstat_campaign |
string | да | да | Идентификатор рекламной кампании | ||
openstat_service |
string | да | да | Идентификатор сервиса, предоставляющего услуги | ||
openstat_source |
string | да | да | Идентификатор площадки, раздела, страницы, было показано соответствующее рекламное объявление | ||
| Другие URL-метки | ||||||
ef_id |
string | да | да | Используется для разметки ссылок в системе управления контекстной рекламой AdLense | ||
yclid |
string | да | да | Yandex Click Identifier | ||
gclid |
string | да | да | Метка gclid | ||
cm_id |
string | да | да | cm_id - это набор ValueTrack. ValueTrack - это параметры URL, которые можно добавлять к URL целевых страниц, чтобы собирать информацию об источнике кликов. | ||
ymclid |
string | да | да | Значение метки ymclid
|
||
tag_from |
string | да | да | Метка from | ||
| География | ||||||
visitor_country |
string | да | да | Страна посетителя | ||
visitor_region |
string | да | да | Регион посетителя | ||
visitor_city |
string | да | да | Город посетителя | ||
visitor_provider |
string | да | да | Интернет провайдер посетителя | ||
visitor_ip_address |
string | да | да | IP-адрес посетителя | ||
| Компьютер | ||||||
visitor_browser_name |
string | да | да | Браузер посетителя | ||
visitor_browser_version |
string | да | да | Версия браузера посетителя | ||
visitor_os_name |
string | да | да | Название операционной системы посетителя | ||
visitor_os_version |
string | да | да | Версия операционной системы посетителя | ||
visitor_language |
string | да | да | Локализация устройства посетителя | ||
visitor_screen |
string | да | да | Разрешение монитора посетителя | ||
visitor_device |
object | да | да | Устройство посетителя | ||
value
|
string | Имя значений | ||||
value_id
|
string | Уникальный идентификатор значения | ||||
| История посетителя | ||||||
visitor_session_id |
string | да | да | Уникальный идентификатор сессии посетителя | ||
visit_depth |
number | да | да | Глубина просмотра. Кол-ва страниц которые были просмотрены за одно посещение | ||
entrance_page |
string | да | да | Страница входа | ||
visitor_type |
object | да | да | Тип посетителя | ||
value
|
string | Имя значений | ||||
value_id
|
string | Уникальный идентификатор значения | ||||
visitor_id |
number | да | да | да | Уникальный идентификатор посетителя | |
person_id |
number | да | да | да | Уникальный идентификатор персоны | |
ua_client_id |
string | да | да | Уникальный идентификатор в Universal Analytics | ||
ym_client_id |
string | да | да | Уникальный идентификатор пользователя Яндекс.Метрики | ||
| Список сегментов | ||||||
segments |
array | да | Сегменты | |||
segment_name |
string | да | Название сегмента | |||
| Время посещения | ||||||
visit_date_time |
iso8601 | YYYY-MM-DD hh:mm:ss | да | да | да | Дата и время посещения |
visit_date |
iso8601 | YYYY-MM-DD | да | да | Дата посещения | |
visit_hour |
object | да | да | Час посещения | ||
value
|
string | Имя значений | ||||
value_id
|
string | Уникальный идентификатор значения | ||||
visit_weekday |
object | да | да | День недели посещения | ||
value
|
string | Имя значений | ||||
value_id
|
string | Уникальный идентификатор значения | ||||
visit_month |
object | да | да | Месяц посещения | ||
value
|
string | Имя значений | ||||
value_id
|
string | Уникальный идентификатор значения | ||||
visit_year |
string | да | да | Год посещения | ||
communications |
array | нет | нет | нет | Связанные обращения | |
id
|
number | Уникальный идентификатор обращения | ||||
type
|
object | Тип обращения | ||||
value
|
string | Имя значений | ||||
value_id
|
string | Уникальный идентификатор значения | ||||
date_time
|
number | Дата обращения | ||||
number_pool_name |
string | нет | нет | нет | Название правила коллтрекинга в которое попало посещение | |
JSON структура запроса
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.visits",
"params":{
"access_token":"string",
"user_id":"number",
"offset":"number",
"limit":"number",
"report_id": "number",
"date_from":"iso8601",
"date_till":"iso8601",
"filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields:[
"string"
]
}
}
JSON структура ответа
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"result":{
"metadata":{
},
"data":[
{
"site_domain_name":"string",
"site_domain_naked":"string",
"pc":"string",
"pc_ext_id":"string",
"campaign_name":"string",
"channel_new":"string",
"channel_code":"string",
"source_new":"string",
"source_name":"string",
"channel":"string",
"source":"string",
"referrer":"string",
"referrer_domain":"string",
"search_query":"string",
"utm_source":"string",
"utm_medium":"string",
"utm_term":"string",
"utm_content":"string",
"utm_campaign":"string",
"utm_referrer":"string",
"utm_expid":"string",
"openstat_ad":"string",
"openstat_campaign":"string",
"openstat_service":"string",
"openstat_source":"string",
"ef_id":"string",
"yclid":"string",
"gclid":"string",
"cm_id":"string",
"ymclid":"string",
"tag_from":"string",
"visit_depth":"number",
"visitor_country":"string",
"visitor_region":"string",
"visitor_city":"string",
"visitor_provider":"string",
"visitor_ip_address":"string",
"visitor_browser_name":"string",
"visitor_browser_version":"string",
"visitor_os_name":"string",
"visitor_os_version":"string",
"visitor_language":"string",
"visitor_screen":"string",
"visitor_device":{
"value_id": "string",
"value": "string"
},
"number_pool_name": "string",
"communications": [
{
"id": "number",
"type": {
"value": "string",
"value_id": "string"
},
"date_time": "iso8601"
}
]
"visitor_session_id":"string",
"entrance_page":"string",
"visitor_type":{
"value_id": "string",
"value": "string",
},
"visitor_id":"number",
"person_id":"number",
"ua_client_id":"string",
"ym_client_id":"string",
"segments":[
{
"segment_name":"string"
}
],
"visit_date_time":"iso8601",
"visit_date":"iso8601",
"visit_hour":{
"value_id": "string",
"value": "string"
},
"visit_weekday":{
"value_id": "string",
"value": "string"
},
"visit_month":{
"value_id": "string",
"value": "string"
},
"visit_year":"string",
"gr":"string",
"gr_ext_id":"string",
"ad":"string",
"ad_ext_ids":"string",
"kw":"string",
"kw_ext_id":"string"
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"