Узнать количество задач

Запрос позволяет узнать количество задач, удовлетворяющих условиям вашего запроса.

POST

https://api.tracker.yandex.net/v3/issues/_count

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

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

Для получения числа задач, удовлетворяющих определенным критериям, используйте HTTP-запрос с методом POST. Критерии для поиска передаются в теле запроса в формате JSON:

POST /v3/issues/_count
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
"filter": {
    "<имя_поля>": "<значение_в_поле>"
  },
  "query": "<фильтр_на_языке_запросов>"
}
Заголовки
  • Host: адрес узла, предоставляющего API.

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

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

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

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

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

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

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

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

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

Параметр Описание Формат
filter Параметры фильтрации задач. В параметре можно указать название любого поля и значение, по которому будет производиться фильтрация. Объект
query Фильтр на языке запросов. Строка

Запрос количества задач с указанием дополнительных параметров фильтрации:

  • Используется HTTP-метод POST.
  • Ответ должен содержать только количество задач из очереди «JUNE», в которых не указан исполнитель.
POST /v3/issues/_count HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "filter": {
    "queue": "JUNE",
    "assignee": "empty()"
  }
}

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

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

В ответе содержится число задач, удовлетворяющих условиям вашего запроса.

5221186

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

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