Предыдущая версия справа и слева
Предыдущая версия
|
|
external:integration:api:time [2020/08/13 15:23] alexander удалено |
— (текущий) |
{{indexmenu_n>30}} | |
======= Распределение аналитических метрик во времени ====== | |
| |
Возвращает распределение метрик по времени. | |
| |
* obj_id - уникальный идентификатор объекта на сервере Shopster, | |
* time - интервал времени, для которых приводятся данные статистики. В случае выбора "hourly" в качестве параметра "interval" в запросе time выражается в минутах. При выборе "interval" равным "daily" данные "time" выражаются в виде номера дня недели (1 - понедельник и т.д.), | |
* avg_count_session - среднее количество сессий, усредненное по интервалам time в периоде от "from" до "to", указанных в параметрах запроса, | |
* avg_count_client - среднее количество уникальных MAC-адресов, усредненное по интервалам time в периоде от "from" до "to", указанных в параметрах запроса, | |
* avg_session_duration - средняя продолжительность сессии в минутах, усредненная по интервалам time в периоде от "from" до "to", указанных в параметрах запроса, | |
* avg_count_comeback_client - среднее количество уникальных MAC-адресов, зарегистрированных более одного раза в течение окна возвратов (параметр "comeback" в запросе), усредненное по интервалам time в периоде от "from" до "to", указанных в параметрах запроса, | |
* user_type - категория зарегистрированных устройств (all - все, passer - прохожие, visitor - посетители, bounced - невовлеченные посетители, half engaged - полувовлеченные посетители, engaged - вовлеченные посетители, employee - сотрудники). Тип вовлеченности определяется на основании переданных параметров bounce_threshold и engagement_threshold. Проведшие менее bounce_threshold - невовлеченные, проведшие более bounce_threshold, но менее engagement_threshold - полувовлеченные, проведшие более engagement_threshold - вовлеченные. | |
| |
===== URL ===== | |
''/reports/time'' | |
| |
===== Method ===== | |
''GET'' | |
| |
===== GET Params ===== | |
* ''from=[date]'' | |
* ''to=[date]'' | |
* ''objects=[[]int]'' | |
* ''interval=[daily|hourly]'' | |
* ''comeback=[2 week|1 month|2 month|3 month|6 month|1 year|10 year]'' | |
* ''bounce_threshold=[2 minute|5 minute|10 minute|15 minute|20 minute|30 minute|45 minute]'' | |
* ''engagement_threshold=[2 minute|5 minute|10 minute|15 minute|20 minute|30 minute|45 minute]'', должен быть больше или равен bounce_threshold | |
| |
===== Headers ===== | |
''x-token=[string]'' | |
| |
===== Response ===== | |
<code javascript> | |
{ | |
"1290": { | |
"visitor": [ | |
{ | |
"obj_id": 1290, | |
"time": 1020, | |
"avg_count_session": 48, | |
"avg_count_client": 48, | |
"avg_session_duration": 13, | |
"avg_count_comeback_client": 11, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 540, | |
"avg_count_session": 2, | |
"avg_count_client": 2, | |
"avg_session_duration": 5, | |
"avg_count_comeback_client": 1, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 1080, | |
"avg_count_session": 46, | |
"avg_count_client": 46, | |
"avg_session_duration": 13, | |
"avg_count_comeback_client": 8, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 1320, | |
"avg_count_session": 2, | |
"avg_count_client": 2, | |
"avg_session_duration": 3, | |
"avg_count_comeback_client": 1, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 900, | |
"avg_count_session": 49, | |
"avg_count_client": 49, | |
"avg_session_duration": 13, | |
"avg_count_comeback_client": 10, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 840, | |
"avg_count_session": 49, | |
"avg_count_client": 49, | |
"avg_session_duration": 13, | |
"avg_count_comeback_client": 9, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 1200, | |
"avg_count_session": 34, | |
"avg_count_client": 34, | |
"avg_session_duration": 13, | |
"avg_count_comeback_client": 7, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 720, | |
"avg_count_session": 31, | |
"avg_count_client": 31, | |
"avg_session_duration": 11, | |
"avg_count_comeback_client": 6, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 1260, | |
"avg_count_session": 17, | |
"avg_count_client": 17, | |
"avg_session_duration": 12, | |
"avg_count_comeback_client": 5, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 780, | |
"avg_count_session": 41, | |
"avg_count_client": 41, | |
"avg_session_duration": 13, | |
"avg_count_comeback_client": 8, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 660, | |
"avg_count_session": 23, | |
"avg_count_client": 23, | |
"avg_session_duration": 12, | |
"avg_count_comeback_client": 4, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 600, | |
"avg_count_session": 10, | |
"avg_count_client": 10, | |
"avg_session_duration": 12, | |
"avg_count_comeback_client": 3, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 960, | |
"avg_count_session": 51, | |
"avg_count_client": 51, | |
"avg_session_duration": 12, | |
"avg_count_comeback_client": 11, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
}, | |
{ | |
"obj_id": 1290, | |
"time": 1140, | |
"avg_count_session": 43, | |
"avg_count_client": 43, | |
"avg_session_duration": 13, | |
"avg_count_comeback_client": 8, | |
"user_type": "visitor", | |
"datetime": "0001-01-01T00:00:00Z" | |
} | |
] | |
} | |
} | |
</code> | |
| |
===== Request ===== | |
'' | |
curl 'https://api-public.getshopster.net/reports/time?objects=1290&from=2016-02-01&to=2016-02-14&bounce_threshold=5+minute&engagement_threshold=20+minute&comeback=2+week&interval=daily' -H 'x-token: xxxx' | |
'' | |