Skip to main content
GET
Get events

Авторизации

Authorization
string
header
обязательно

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Заголовки

X-Tenant-Id
integer

Компания, в контексте которой выполняется запрос — её id из GET /v1/tenant/. Пользователь должен состоять в этой компании: чужой id доступа к данным не даёт. Без заголовка компания определяется по домену запроса.

Параметры запроса

action
string[]

Несколько значений могут быть разделены запятыми.

actor
number
actor_type
enum<string>
  • user - Пользователь
  • client - Клиент
  • anonymous - Анонимно
  • system - Система
  • integration - Интеграция
  • platform - Платформа
Доступные опции:
anonymous,
client,
integration,
platform,
system,
user
category
enum<string>
  • order - Аренда
  • inventory - Инвентарь
  • client - Клиент
  • finance - Финансы
  • auth - Доступ
  • staff - Сотрудники
  • settings - Настройки
  • integration - Интеграция
  • document - Документ
  • billing - Подписка
  • storefront - Витрина
  • report - Отчёты
  • task - Задачи
Доступные опции:
auth,
billing,
client,
document,
finance,
integration,
inventory,
order,
report,
settings,
staff,
storefront,
task
content_type
string
created_at__gte
string<date-time>
created_at__lte
string<date-time>
cursor
string

The pagination cursor value.

object_id
number
pageSize
integer

Number of results to return per page.

request_id
string
role
enum<string>
  • primary - Основной
  • parent - Родительский
  • related - Связанный
Доступные опции:
parent,
primary,
related

A search term.

Ответ

200 - application/json
results
object[]
обязательно
next
string<uri> | null
Пример:

"http://api.example.org/accounts/?cursor=cD00ODY%3D\""

previous
string<uri> | null
Пример:

"http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"