Найти отчеты по задачам

Запрос позволяет найти отчеты по задачам, удовлетворяющие заданным критериям.

POST

https://api.tracker.yandex.net/v3/entities/report/_search

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

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

Чтобы найти отчеты, используйте HTTP-запрос с методом POST. В теле запроса укажите параметры поиска в формате JSON.

POST /v3/entities/report/_search
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
Content-Type: application/json
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
   "filter":
   {
      "author": "<логин_пользователя>"
   }
}

Заголовки

Host: адрес узла, предоставляющего API.
Authorization: токен для авторизации в одном из форматов:
- OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее
- Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. Читать подробнее
Content-Type: формат тела запроса. Должен иметь значение application/json.
X-Org-ID или X-Cloud-Org-ID: идентификатор организации.
- если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,
- если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок X-Cloud-Org-ID.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

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

Тело запроса содержит информацию, необходимую для поиска отчетов:

Дополнительные параметры

Параметр	Описание	Тип данных
filter	Параметры фильтрации отчетов.	Объект
orderBy	Поле для сортировки отчетов. Допустимые значения: `id`, `shortId`, `createdBy`, `createdAt`, `updatedAt`, `self`.	Строка
orderAsc	Направление сортировки: `true` — по возрастанию, `false` — по убыванию.	Логический

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

Для фильтрации доступны только следующие ключи: id, shortId, author.

Параметр	Описание	Тип данных
id	Идентификатор отчета.	Строка
shortId	Короткий идентификатор отчета.	Число
author	Автор отчета. Значение берется из параметра `id` поля `createdBy` тела ответа.	Строка или число

Пагинация

Метод поддерживает постраничную выдачу результатов. Параметры пагинации передаются в строке запроса:

Параметр	Описание	Тип данных
perPage	Количество отчетов на одной странице ответа. Значение по умолчанию — 50.	Число
page	Номер страницы выдачи. Значение по умолчанию — 1.	Число

Пример: Найти отчеты конкретного автора

Используется HTTP-метод POST.

В выдачу попадают отчеты, созданные пользователем с указанным id.
POST /v3/entities/report/_search?perPage=5 HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
Content-Type: application/json
X-Cloud-Org-ID: ab1c******

{
  "filter": {
    "author": "<id_пользователя>"
  }
}

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

Запрос выполнен успешно

Запрос выполнен с ошибкой

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

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

{
    "hits": 2,
    "pages": 1,
    "values": [
        {
            "self": "https://api.tracker.yandex.net/v3/entities/report/6a0d7cfb81208304d255f618",
            "id": "6a0d7cfb81208304d255f618",
            "version": 5,
            "shortId": 185,
            "entityType": "report",
            "createdBy": {
                "self": "https://api.tracker.yandex.net/v3/users/8000000000000005",
                "id": "8000000000000005",
                "display": "Имя Фамилия",
                "cloudUid": "ajemqnuerc0d4oaf598d",
                "passportUid": 1987441286
            },
            "createdAt": "2026-05-20T09:20:59.753+0000",
            "updatedAt": "2026-05-20T09:21:00.085+0000"
        },
        {
            "self": "https://api.tracker.yandex.net/v3/entities/report/6a0d7cec7e0f032a528bbcd4",
            "id": "6a0d7cec7e0f032a528bbcd4",
            "version": 27,
            "shortId": 184,
            "entityType": "report",
            "createdBy": {
                "self": "https://api.tracker.yandex.net/v3/users/8000000000000005",
                "id": "8000000000000005",
                "display": "Имя Фамилия",
                "cloudUid": "ajemqnuerc0d4oaf598d",
                "passportUid": 1987441286
            },
            "createdAt": "2026-05-20T09:20:44.592+0000",
            "updatedAt": "2026-05-20T09:21:07.234+0000"
        }
    ]
}

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

Параметр	Описание	Тип данных
hits	Общее количество найденных отчетов.	Число
pages	Общее количество страниц выдачи.	Число
orderBy	Поле, по которому отсортированы отчеты. Возвращается, если в запросе передан параметр `orderBy`. Значения `createdBy`, `createdAt` и `updatedAt` возвращаются как `author`, `created` и `updated`.	Строка
values	Результаты. Объекты отчетов.	Массив объектов

Если применяется пагинация, параметр pages равен количеству страниц, на которые разбиваются все найденные отчеты при заданном размере страницы. Значение вычисляется как hits (общее количество найденных отчетов), разделенное на perPage (количество отчетов на одной странице), с округлением вверх. Например, при hits: 42 и perPage: 2 параметр pages равен 21.

Поля объектов отчетов

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию об отчете.	Строка
id	Идентификатор отчета. Чтобы открыть отчет в интерфейсе Трекера, подставьте идентификатор в адрес и откройте его в браузере: `https://tracker.yandex.ru/pages/reports/<id_отчета>`	Строка
version	Версия отчета.	Число
shortId	Короткий идентификатор отчета.	Число
entityType	Тип сущности. Значение: `report`.	Строка
createdBy	Объект с информацией о создателе отчета.	Объект
createdAt	Дата и время создания отчета в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`.	Строка
updatedAt	Дата и время последнего обновления отчета в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`.	Строка

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о пользователе.	Строка
id	Идентификатор пользователя.	Строка
display	Отображаемое имя пользователя.	Строка
passportUid	Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID.	Число
cloudUid	Уникальный идентификатор пользователя в Yandex Identity Hub.	Строка

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

400: Один или несколько параметров запроса имеют недопустимое значение.

401: Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.

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

404: Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

422: Ошибка валидации JSON, запрос отклонен.

Была ли статья полезна?

Создать отчет по задачам

Получить историю изменений задачи