Экспорт событий аудита

Метод GET /v1/organizations/{organizationId}/audit_events возвращает события аудита выбранной организации.

Перед началом

Для запроса нужны:

Персональный токен со скоупом organization:audit_events_read.
Идентификатор организации. Он указан в адресе страницы организации после /org/: /org/{organizationId}/....
Пользователь, создавший токен, должен быть администратором выбранной организации.

Отправка запроса

Отправьте запрос с токеном в заголовке Authorization:

curl \
  "https://api.holst.so/v1/organizations/{organizationId}/audit_events" \
  -H "Authorization: Bearer holst_pat_..."

Этот запрос вернёт до 100 последних событий, начиная с самых новых.

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

actionTypes — типы действий для фильтрации событий. Несколько значений разделяются запятыми. Возможные значения перечислены в разделе «Типы действий».
startTime и endTime — начало и конец периода в формате RFC 3339.
order — порядок событий: asc начинает со старых, desc — с новых. По умолчанию используется desc.
pageSize — количество событий на странице от 1 до 1000. По умолчанию — 100.

Например, так можно получить события создания рабочих пространств за август 2026 года:

curl --get \
  "https://api.holst.so/v1/organizations/{organizationId}/audit_events" \
  -H "Authorization: Bearer holst_pat_..." \
  --data-urlencode "actionTypes=workspace_create" \
  --data-urlencode "startTime=2026-08-01T00:00:00Z" \
  --data-urlencode "endTime=2026-09-01T00:00:00Z" \
  --data-urlencode "order=asc" \
  --data-urlencode "pageSize=1000"

Ответ API

Ответ содержит:

auditEvents — массив событий аудита в порядке, заданном параметром order.
nextCursor — курсор следующей страницы. Поле отсутствует, если других событий нет.

Поля каждого события описаны в разделе «Структура события».

Получение следующей страницы

Если в ответе есть nextCursor, передайте его значение в параметре cursor:

curl --get \
  "https://api.holst.so/v1/organizations/{organizationId}/audit_events" \
  -H "Authorization: Bearer holst_pat_..." \
  --data-urlencode "actionTypes=workspace_create" \
  --data-urlencode "startTime=2026-08-01T00:00:00Z" \
  --data-urlencode "endTime=2026-09-01T00:00:00Z" \
  --data-urlencode "order=asc" \
  --data-urlencode "pageSize=1000" \
  --data-urlencode "cursor=NEXT_CURSOR"

Если в первом запросе использовались фильтры или сортировка, передавайте их без изменений на каждой странице. Повторяйте запрос, пока nextCursor не исчезнет из ответа.

Справочник метода

Описание параметров, ответа и возможных ошибок приведено в разделе «Получить события аудита».