Просмотреть логи автодействия

Вы можете получить логи с информацией о всех запусках автодействия, а также логи с информацией о конкретном запуске автодействия со списком найденных задач:

Просмотреть логи можно только для автодействий, которые настраивают автоматическое обновление задач.

Получить информацию о всех запусках автодействия

GET

https://api.tracker.yandex.net/v3/queues/{ключ_очереди}/autoactions/{id_автодействия}/logs

Формат запроса

Перед выполнением запроса получите доступ к API.

Для получения логов используйте HTTP-запрос с методом GET:

GET /v3/queues/{ключ_очереди}/autoactions/{id_автодействия}/logs
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
Заголовки

  • Host: адрес узла, предоставляющего API.

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth OAUTH_TOKEN при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer IAM_TOKEN при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,

    • если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок X-Cloud-Org-ID.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс
Параметр Описание Тип данных
ключ_очереди Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка
id_автодействия Идентификатор автодействия. Строка

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит результаты в формате JSON.

[
{
    "id": "6819cc43d8f6f0**********",
    "launchTime": "2025-05-06T08:45:55.778+0000",
    "searchHits": 3,
    "successes": 3,
    "failures": 0,
    "searchFailed": false
},
...
]
Параметры ответа
Параметр Описание Тип данных
id Идентификатор запуска автодействия. Строка
launchTime Время начала запуска автодействия в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Строка
searchHits Количество задач, обработанных автодействием. Число
successes Количество задач, в которых автодействие сработало. Число
failures Количество задач, в которых автодействие не сработало. Число
searchFailed Параметр показывает, была ли хотя одна задача обработана автодействием:
  • true — ни одна задача не была обработана;
  • false — хотя бы одна задача была обработана.
 Логический

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

400
Один или несколько параметров запроса имеют недопустимое значение.
401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.

Получить информацию о конкретном запуске автодействия

GET

https://api.tracker.yandex.net/v3/queues/QUEUE_ID/autoactions/AUTOACTION_ID/logs/AUTOACTION_RUN_ID

Формат запроса

Перед выполнением запроса получите доступ к API.

Для получения логов используйте HTTP-запрос с методом GET:

GET /v3/queues/{ключ_очереди}/autoactions/{id_автодействия}/logs/{id_запуска_автодействия}
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
Заголовки

  • Host: адрес узла, предоставляющего API.

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth OAUTH_TOKEN при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer IAM_TOKEN при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,

    • если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок X-Cloud-Org-ID.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс
Параметр Описание Тип данных
ключ_очереди Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка
id_автодействия Идентификатор автодействия. Строка
id_запуска_автодействия Идентификатор запуска автодействия. Строка

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит результаты в формате JSON.

[
{
    "id": 0,
    "issueReference": {
        "self": "https://api.tracker.yandex.net/v3/issues/TEST-1",
        "id": "66f682f13f442b**********",
        "version": 0,
        "key": "TEST-1",
        "display": "My issue"
    },
    "status": {
        "value": "success",
        "display": "Success"
    }
},
...
]
Параметры ответа
Параметр Описание Тип данных
id Идентификатор показывает порядковый номер срабатывания автодействия. Отсчет начинается с нуля. Число
issueReference Информация о задаче. Объект
status Информация о статусе запроса. Объект

Поля объекта issueReference

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о задаче. Строка
id Идентификатор задачи. Строка
version Версия задачи. Каждое изменение параметров задачи увеличивает номер версии. Редактирование задачи будет заблокировано, если версия достигнет предельного значения: для роботов 10100, для пользователей 11100. Число
key Ключ задачи. Строка
display Отображаемое название задачи. Строка или объект

Поля объекта status

Параметр Описание Тип данных
value Значение статуса. Строка
display Отображаемое название статуса. Строка или объект

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

400
Один или несколько параметров запроса имеют недопустимое значение.
401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
Предыдущая
Получить параметры автодействия
Следующая
Создать триггер