События

Получение событий

Возвращает список событий (клики, посещения страниц, ввод данных, пользовательские события и т. д.), зафиксированных в конкретной сессии. Область сессии задаётся сервером — параметр пути sessionID автоматически добавляется в качестве фильтра событий.

Метод

POST

URL

/public/:projectKey/sessions/:sessionId/events

Параметры

Имя	Тип	Описание
projectKey	string	Ключ проекта (обязательно)
sessionId	string	Идентификатор сессии (обязательно, макс. 256)

Тело запроса

Имя	Тип	Описание
startTimestamp	epoch (ms)	Начало временного окна (обязательно, мин. 946684800000)
endTimestamp	epoch (ms)	Конец временного окна (обязательно, > startTimestamp)
limit	integer	Размер страницы, 1-200 (обязательно)
page	integer	Номер страницы, начинается с 1 (обязательно)
sortBy	string	Столбец события для сортировки (необязательно)
sortOrder	string	`asc` или `desc` (необязательно)
filters	array	Дополнительные фильтры событий (необязательно) — см. структуру фильтра ниже
columns	array	Столбцы событий для включения в ответ (необязательно)

Объект фильтра:

Имя	Тип	Описание
name	string	Имя атрибута фильтра (обязательно, макс. 256)
operator	string	Оператор сравнения (например, `is`, `contains`)
value	string[]	До 10 значений, каждое максимум 256 символов
isEvent	boolean	Указывает, нацелен ли фильтр на свойство события
dataType	string	Одно из `string`, `number`, `boolean`, `integer`, `timestamp`

Заголовки запроса

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

Коды состояния

200 Ответ отправлен в виде JSON в теле
400 Недопустимое тело или недопустимый sessionID (пустой или > 256 символов)

Пример запроса

curl -X POST \
  {BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/sessions/4813023023591169/events \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}' \
  --data-raw '{
    "startTimestamp": 1623440000000,
    "endTimestamp":   1623441000000,
    "limit": 100,
    "page":  1,
    "sortOrder": "asc"
  }'

Пример ответа

{
  "data": {
    "total": 3,
    "events": [
      {
        "event_id": "01H7Z...",
        "$event_name": "$pageview",
        "created_at": 1623440905732,
        "distinct_id": "mickael@openreplay.com",
        "session_id": "4813023023591169",
        "properties": { "path": "/my-account/" }
      },
      {
        "event_id": "01H7Z...",
        "$event_name": "$click",
        "created_at": 1623440915126,
        "distinct_id": "mickael@openreplay.com",
        "session_id": "4813023023591169",
        "$properties": { "label": "Shop" },
        "$auto_captured": true
      }
    ]
  }
}