|
Следующая версия
|
Предыдущая версия
|
external:integration:api:time [2017/05/18 10:52]
admin created |
external:integration:api:time [2020/08/13 15:23]
alexander удалено |
| # Распределение аналитических метрик во времени | {{indexmenu_n>30}} |
| | ======= Распределение аналитических метрик во времени ====== |
| |
| Возвращает распределение метрик по времени. | Возвращает распределение метрик по времени. |
| |
| * obj_id - уникальный идентификатор объекта на сервере Shopster, | * obj_id - уникальный идентификатор объекта на сервере Shopster, |
| * time - интервал времени, для которых приводятся данные статистики. В случае выбора "hourly" в качестве параметра "interval" в запросе time выражается в минутах. При выборе "interval" равным "daily" данные "time" выражаются в виде номера дня недели (1 - понедельник и т.д.), | * time - интервал времени, для которых приводятся данные статистики. В случае выбора "hourly" в качестве параметра "interval" в запросе time выражается в минутах. При выборе "interval" равным "daily" данные "time" выражаются в виде номера дня недели (1 - понедельник и т.д.), |
| * avg_count_session - среднее количество сессий, усредненное по интервалам time в периоде от "from" до "to", указанных в параметрах запроса, | * avg_count_session - среднее количество сессий, усредненное по интервалам time в периоде от "from" до "to", указанных в параметрах запроса, |
| * avg_count_client - среднее количество уникальных MAC-адресов, усредненное по интервалам time в периоде от "from" до "to", указанных в параметрах запроса, | * avg_count_client - среднее количество уникальных MAC-адресов, усредненное по интервалам time в периоде от "from" до "to", указанных в параметрах запроса, |
| * avg_session_duration - средняя продолжительность сессии в минутах, усредненная по интервалам time в периоде от "from" до "to", указанных в параметрах запроса, | * avg_session_duration - средняя продолжительность сессии в минутах, усредненная по интервалам time в периоде от "from" до "to", указанных в параметрах запроса, |
| * avg_count_comeback_client - среднее количество уникальных MAC-адресов, зарегистрированных более одного раза в течение окна возвратов (параметр "comeback" в запросе), усредненное по интервалам 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 - вовлеченные. | * user_type - категория зарегистрированных устройств (all - все, passer - прохожие, visitor - посетители, bounced - невовлеченные посетители, half engaged - полувовлеченные посетители, engaged - вовлеченные посетители, employee - сотрудники). Тип вовлеченности определяется на основании переданных параметров bounce_threshold и engagement_threshold. Проведшие менее bounce_threshold - невовлеченные, проведшие более bounce_threshold, но менее engagement_threshold - полувовлеченные, проведшие более engagement_threshold - вовлеченные. |
| |
| ## URL | ===== URL ===== |
| `/reports/time` | ''/reports/time'' |
| |
| ## Method | ===== Method ===== |
| `GET` | ''GET'' |
| |
| ## GET Params | ===== GET Params ===== |
| `from=[date]`<br /> | * ''from=[date]'' |
| `to=[date]`<br /> | * ''to=[date]'' |
| `objects=[[]int]`<br /> | * ''objects=[[]int]'' |
| `interval=[daily|hourly]`<br /> | * ''interval=[daily|hourly]'' |
| `comeback=[2 week|1 month|2 month|3 month|6 month|1 year|10 year]`<br /> | * ''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]`<br /> | * ''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 | * ''engagement_threshold=[2 minute|5 minute|10 minute|15 minute|20 minute|30 minute|45 minute]'', должен быть больше или равен bounce_threshold |
| | |
| ## Headers | ===== Headers ===== |
| `x-token=[string]` | ''x-token=[string]'' |
| |
| ## Response | ===== Response ===== |
| ```javascript | <code javascript> |
| { | { |
| "1290": { | "1290": { |
| } | } |
| } | } |
| ``` | </code> |
| | |
| ## Request | |
| ``` | |
| curl 'https://api-public.getshopster.com/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' | |
| ``` | |
| |
| | ===== 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' |
| | '' |
