События

Получить список событий

Запрос events позволяет получить список событий, приходящих c OMNI Agent. API-запрос events доступен по ссылке http://$DOMAIN/event-service/graphql.

{ events() { }}

Для выполнения запроса укажите ключ авторизации из веб-интерфейса OMNI Platform в Headers.

Выходные параметры:

• filters:
  • id:
    • exact:
      • Идентификатор события
      • Тип данных: ID
  • type:
    • exact:
      • Тип события: IDENTIFICATION, NON_IDENTIFICATION, HAR, ROI, CROSSING
  • date:
    • exact
      • Точная дата события
      • Формат данных: ISO 8601
    • gt
      • Вывести события, произошедшие позднее этой даты
      • Формат данных: ISO 8601
    • gte
      • Вывести события, произошедшие в указанную дату или позднее этой даты
      • Формат данных: ISO 8601
    • lt
      • Вывести события, произошедшие ранее этой даты
      • Формат данных: ISO 8601
    • lte
      • Вывести события, произошедшие в указанную дату или ранее этой даты
      • Формат данных: ISO 8601
  • dataIdentificationDataProfileId:
    • exact:
      • Идентификатор профиля
      • Тип данных: ID
  • activityId:
    • exact:
      • Идентификатор активности
      • Тип данных: ID
• order:
  • date (Сортировка списка событий по дате):
    • ASC: от самого раннего к самому позднему
    • DESC: от самого позднего к самому раннему
• pagination:
  • offset
    • Позволяет удалить последние n событий из списка.
    • Тип данных: Int.
  • limit
    • Позволяет получить последние n событий из списка.
    • Тип данных: Int.

Выходные параметры:

• totalCount
  • Общее количество найденных событий
  • Тип данных: Int.
• collectionItems: EventOutput:
  • id
    • Идентификатор события
    • Тип данных: ID.
  • creationDate
    • Дата создания события
    • Формат данных: Дата и время в формате ISO.
  • lastModified
    • Дата последнего изменения события
    • Формат данных: Дата и время в формате ISO.
  • data
    • Данные о событии, например идентификатор кропа лица и идентификатор полного кадра
    • Формат данных: JSON.
  • agentId
    • Идентификатор агента, с которого пришло событие
    • Тип данных: ID.
  • cameraId
    • Идентификатор камеры, с которой пришло событие
    • Тип данных: ID.
  • type
    • Тип события: IDENTIFICATION, NON_IDENTIFICATION, HAR, ROI, CROSSING
  • workspaceId
    • Идентификатор воркспейса
    • Тип данных: ID.
  • activityId
    • Идентификатор активности
    • Тип данных: ID

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

{
  events(filters: {date: {exact: "2023-05-30T08:20:05.041000+00:00"}}) {
    totalCount
    collectionItems {
    id
    date
    data
    agentId
    cameraId
    creationDate
    lastModified
    type
    workspaceId
    activityId
    }
  }
}

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

API возвращает следующий результат:

{
  "data": {
    "events": {
    "totalCount": 1,
    "collectionItems": [
        {
        "id": "***",
        "date": "2023-05-30T08:20:05.041000+00:00",
        "data": {
            "$image": {
            "id": "***"
            },
            "$original_image": {
            "id": "***"
            }
        },
        "agentId": "***",
        "cameraId": "***",
        "creationDate": "2023-05-30T08:20:08.106105+00:00",
        "lastModified": "2023-05-30T08:20:08.106105+00:00",
        "type": "NON_IDENTIFICATION",
        "workspaceId": "***",
        "activityId": "***"
          }
       ]
    }
  }
}