Это старая версия документа!


Динамика метрик по времени

Возвращает динамику метрик по времени.

  • obj_id - уникальный идентификатор объекта на сервере Shopster,
  • datetime - дата и время, для которых приводятся данные статистики,
  • count_session - количество сессий, зарегистрированных в интервале от datetime до окончания выбранного периода (параметр «interval» в запросе),
  • count_client - количество уникальных MAC-адресов, зарегистрированных в интервале от datetime до окончания выбранного периода (параметр «interval» в запросе),
  • avg_session_duration - средняя продолжительность сессии посещения в минутах,
  • count_comeback_client - количество уникальных MAC-адресов, зарегистрированных более одного раза в течение окна возвратов (параметр «comeback» в запросе),
  • sum_session_duration - Gross Shopping Hours (Суммарное время всех сессий посещения). Этот атрибут имеет смысл только во временных разрезах от дня и крупнее: daily, weekly, monthly. При выборе hourly, weekend и weekday равен 0,
  • user_type - категория зарегистрированных устройств (all - все, passer - прохожие, visitor - посетители, bounced - невовлеченные посетители, half engaged - полувовлеченные посетители, engaged - вовлеченные посетители, employee - сотрудники). Тип вовлеченности определяется на основании переданных параметров bounce_threshold и engagement_threshold. Проведшие менее bounce_threshold - невовлеченные, проведшие более bounce_threshold, но менее engagement_threshold - полувовлеченные, проведшие более engagement_threshold - вовлеченные.

URL

/reports/datetime

Method

GET

GET Params

  • from=[date]
  • to=[date]
  • objects=[[]int]
  • interval=[hourly|daily|weekly|monthly|weekday|weekend]
  • 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

{
  "1290": {
    "all": [
      {
        "obj_id": 1290,
        "datetime": "2016-02-01T00:00:00Z",
        "count_session": 8495,
        "count_client": 6689,
        "avg_session_duration": 16,
        "count_comeback_client": 1823,
        "sum_session_duration": 81725.23,
        "user_type": "all"
      },
      {
        "obj_id": 1290,
        "datetime": "2016-02-08T00:00:00Z",
        "count_session": 9887,
        "count_client": 7687,
        "avg_session_duration": 17,
        "count_comeback_client": 2139,
        "sum_session_duration": 87622.87,
        "user_type": "all"
      }
    ],
    "bounced": [
      {
        "obj_id": 1290,
        "datetime": "2016-02-01T00:00:00Z",
        "count_session": 780,
        "count_client": 741,
        "avg_session_duration": 2,
        "count_comeback_client": 131,
        "sum_session_duration": 861.73,
        "user_type": "bounced"
      },
      {
        "obj_id": 1290,
        "datetime": "2016-02-08T00:00:00Z",
        "count_session": 897,
        "count_client": 840,
        "avg_session_duration": 2,
        "count_comeback_client": 151,
        "sum_session_duration": 916.62,
        "user_type": "bounced"
      }
    ],
    "employee": [
      {
        "obj_id": 1290,
        "datetime": "2016-02-01T00:00:00Z",
        "count_session": 364,
        "count_client": 81,
        "avg_session_duration": 139,
        "count_comeback_client": 64,
        "sum_session_duration": 7512.91,
        "user_type": "employee"
      },
      {
        "obj_id": 1290,
        "datetime": "2016-02-08T00:00:00Z",
        "count_session": 318,
        "count_client": 70,
        "avg_session_duration": 132,
        "count_comeback_client": 53,
        "sum_session_duration": 7560.51,
        "user_type": "employee"
      }
    ],
    "engaged": [
      {
        "obj_id": 1290,
        "datetime": "2016-02-01T00:00:00Z",
        "count_session": 646,
        "count_client": 619,
        "avg_session_duration": 39,
        "count_comeback_client": 124,
        "sum_session_duration": 10543.38,
        "user_type": "engaged"
      },
      {
        "obj_id": 1290,
        "datetime": "2016-02-08T00:00:00Z",
        "count_session": 832,
        "count_client": 800,
        "avg_session_duration": 40,
        "count_comeback_client": 160,
        "sum_session_duration": 12810.87,
        "user_type": "engaged"
      }
    ],
    "half engaged": [
      {
        "obj_id": 1290,
        "datetime": "2016-02-01T00:00:00Z",
        "count_session": 784,
        "count_client": 756,
        "avg_session_duration": 11,
        "count_comeback_client": 133,
        "sum_session_duration": 7129.75,
        "user_type": "half engaged"
      },
      {
        "obj_id": 1290,
        "datetime": "2016-02-08T00:00:00Z",
        "count_session": 964,
        "count_client": 932,
        "avg_session_duration": 11,
        "count_comeback_client": 176,
        "sum_session_duration": 11548.74,
        "user_type": "half engaged"
      }
    ],
    "passer": [
      {
        "obj_id": 1290,
        "datetime": "2016-02-01T00:00:00Z",
        "count_session": 5706,
        "count_client": 4669,
        "avg_session_duration": 12,
        "count_comeback_client": 1163,
        "sum_session_duration": 15850.35,
        "user_type": "passer"
      },
      {
        "obj_id": 1290,
        "datetime": "2016-02-08T00:00:00Z",
        "count_session": 6471,
        "count_client": 5249,
        "avg_session_duration": 12,
        "count_comeback_client": 1293,
        "sum_session_duration": 17968.27,
        "user_type": "passer"
      }
    ],
    "visitor": [
      {
        "obj_id": 1290,
        "datetime": "2016-02-01T00:00:00Z",
        "count_session": 2210,
        "count_client": 2020,
        "avg_session_duration": 16,
        "count_comeback_client": 339,
        "sum_session_duration": 30597.28,
        "user_type": "visitor"
      },
      {
        "obj_id": 1290,
        "datetime": "2016-02-08T00:00:00Z",
        "count_session": 2693,
        "count_client": 2438,
        "avg_session_duration": 17,
        "count_comeback_client": 433,
        "sum_session_duration": 34571.31,
        "user_type": "visitor"
      }
    ]
  }
}

Request


external/integration/api/datetime.1496069458.txt.gz · Последнее изменение: 2017/05/29 14:50 — admin