API Визитов¶
Получить информацию о всех визитах¶
POST https://cloud.roistat.com/api/v1/project/site/visit/listЭтот метод используется для получения информации о всех визитах.
Для ограничения выборки можно использовать наши стандартные фильтры. Для фильтрации по вложенным значениям необходимо указывать название родительского параметра и через точку название параметра для фильтрации. Например, для фильтрации по источнику перехода: "filters" : [[ "source.system_name", "like", "yandex"]].
Однако фильтрация невозможна по следующим параметрам: google_client_id, metrika_client_id, gclid, fbc, fbp, device, order_ids, source.icon_url, source.openstat, geo.country, geo.region, geo.city, icon_url, country_iso, cost.
Ограничение на один ответ – 10 000 записей. За 1 секунду можно сделать не более 1 запроса, за 1 минуту – не более 15 запросов.
Также реализована поддержка limit и offset.
curl 'https://cloud.roistat.com/api/v1/project/site/visit/list?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '{"filters": [["landing_page", "=", "test.com"],["date", ">=", "2022-10-11T21:00:00.000Z"], ["date", "<=", "2022-10-18T20:59:59.999Z"]]}'
Тело запроса:
{
"data": {
"id": "4336465",
"first_visit_id": "4336465",
"date": "2016-06-19T00:30:31+0000",
"landing_page": "kartinidemo.ru/l/portret-na-zakaz",
"host": "kartinidemo.ru",
"google_client_id": null,
"metrika_client_id": null,
"ip": "37.144.111.135",
"roistat_param1": Friday,
"roistat_param2": null,
"roistat_param3": null,
"roistat_param4": null,
"roistat_param5": null,
"roistat_params": {
"1": Friday,
"2": null,
"3": null,
// Список значений roistat_param до 50
"50": null
},
"device": {
"os": "OS X",
"os_icon": "https://cloud.roistat.com/img/os/macosx.png",
"agent": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36",
"agent_icon": "https://cloud.roistat.com/img/browsers/chrome.png",
"is_mobile": false
},
"source": {
"referrer": "http://yandex.ru",
"system_name": "direct1_search_1_123456_789012",
"display_name": "Яндекс.Директ_Поиск_Картины_Акция",
"display_name_by_level": [
"Яндекс.Директ",
"Поиск",
"Картины",
"Акция"
],
"icon_url": "https://favicon.yandex.net/favicon/vk.com",
"utm_source": null,
"utm_medium": null,
"utm_campaign": null,
"utm_term": null,
"utm_content": null,
"openstat": null
},
"geo": {
"country": "Россия",
"region": "Смоленская область",
"city": "Смоленск",
"icon_url": "/img/country/ru.png",
"country_iso": "RU"
},
"order_ids": [
"62"
],
"cost": 223.18299999999999,
"ab_test": [
{
"test_id": 1,
"test_title": "button",
"variant_id": "1",
"variant_title": "green"
},
{
"test_id": 2,
"test_title": "font",
"variant_id": "1",
"variant_title": "14px"
}
]
},
"total": 1,
"status": "success"
}
Строка запроса:
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| project | string | Номер проекта | да |
Тело запроса:
Стандартные фильтры – см. описание метода и пример запроса.
| Параметр | Тип | Описание |
|---|---|---|
| data | object | |
| > id | string | Текущий номер визита |
| > first_visit_id | string | Номер первого визита в цепочке посещений клиента |
| > date | string | Дата и время визита |
| > landing_page | string | Страница, на которую совершен визит |
| > host | string | Домен |
| > google_client_id | null или string | Значение ClientId, присвоенное счетчиком Google Analytics |
| > metrika_client_id | null или string | Значение ClientId, присвоенное счетчиком Яндекс.Метрики |
| > gclid | null или string | Значение gclid - идентификатор клика по рекламному объявлению Google Ads |
| > fbc | null или string | Значение fbclid, присвоенное пикселем Facebook1 |
| > fbp | null или string | Значение ID браузера fbp, присвоенное пикселем Facebook1 |
| > ip | string | IP посетителя |
| > roistat_param1 | null или string | Значение метки roistat_param1 у посетителя |
| > roistat_param2 | null или string | Значение метки roistat_param2 у посетителя |
| > roistat_param3 | null или string | Значение метки roistat_param3 у посетителя |
| > roistat_param4 | null или string | Значение метки roistat_param4 у посетителя |
| > roistat_param5 | null или string | Значение метки roistat_param5 у посетителя |
| > roistat_params | object | Объект, содержащий значения всех меток roistat_param у посетителя (от roistat_param1 до roistat_param50) |
| >> N | string или null | Значение метки roistat_paramN (N – номер метки от 1 до 50) |
| > device | object | |
| >> os | string | Операционная система посетителя |
| >> os_icon | string | Иконка операционной системы |
| >> agent | string | Браузер посетителя |
| >> agent_icon | string | Иконка браузера |
| >> is_mobile | boolean | true – визит с мобильного устройства |
| > source | object | |
| >> referrer | string | Источник перехода |
| >> system_name | string | Системное название рекламного канала |
| >> display_name | string | Человекочитаемое название рекламного канала |
| >> display_name_by_level | array[string] | Человекочитаемое название рекламного канала по уровням |
| >> icon_url | string | Ссылка на иконку канала |
| >> utm_source | null или string | Значение метки utm_source у посетителя |
| >> utm_medium | null или string | Значение метки utm_medium у посетителя |
| >> utm_campaign | null или string | Значение метки utm_campaign у посетителя |
| >> utm_term | null или string | Значение метки utm_term у посетителя |
| >> utm_content | null или string | Значение метки utm_content у посетителя |
| >> openstat | null или string | Значение метки openstat у посетителя |
| > geo | object | |
| >> country | string | Страна посетителя |
| >> region | string | Регион посетителя |
| >> city | string | Город посетителя |
| >> icon_url | string | Ссылка на иконку страны |
| >> country_iso | string | Код страны |
| > order_ids | array[string] | ID сделок по визиту |
| > cost | number | Себестоимость сделки |
| > ab_test | array[object] | |
| >> test_id | number | ID теста |
| >> test_title | string | Название теста |
| >> variant_id | string | ID варианта |
| >> variant_title | string | Название варианта |
| total | integer | |
| status | string |
Обновить параметры roistat_param в визите¶
POST https://cloud.roistat.com/api/v1/project/site/visit/params/updateДанный метод позволяет обновлять параметры roistat_param в визите.
curl 'https://cloud.roistat.com/api/v1/project/site/visit/params/update?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '{"visit": "123","roistat_param1": "onlineshop","roistat_param48": "Friday"}'
Тело запроса:
Строка запроса:
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| project | string | Номер проекта | да |
Тело запроса:
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| visit | string | да | |
| roistat_paramN | string или null | Можно задать до 50 параметров – от roistat_param1 до roistat_param50 | нет |
| Параметр | Тип | Описание |
|---|---|---|
| status | string |