Найти дашборды

Запрос возвращает дашборды, к которым у пользователя есть доступ. Можно отфильтровать результаты по названию и владельцу.

https://api.tracker.yandex.net/v3/dashboards/_search

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

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

POST /v3/dashboards/_search
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
Content-Type: application/json
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ

{
  "name": "Планы команды",
  "owner": {"login": "user-login"}
}

Механизм пагинации

Запрос использует относительную пагинацию. Результаты отсортированы по убыванию id: сначала новые дашборды. Параметр id возвращает дашборды с идентификатором меньше переданного. Размер страницы задается параметром perPage, по умолчанию — 50. Максимальный размер — 500 дашбордов; большее значение API уменьшает до 500.

1. Для первой страницы выполните запрос без параметра id.
2. Для следующей страницы передайте в id идентификатор последнего дашборда из предыдущего ответа. Сохраните прежнее значение perPage и параметры поиска в теле запроса.
3. Повторяйте запросы с новым id, пока в заголовке Link есть ссылка rel="next".

Если заголовок Link содержит ссылку rel="next", ее можно использовать для следующего запроса с тем же телом. Если этой ссылки нет, вы получили последнюю страницу.

Заголовок X-Total-Count содержит общее число найденных дашбордов, а X-Total-Pages — число страниц при выбранном размере страницы.

Пример последовательных запросов

1. Получите первую страницу:

   POST /v3/dashboards/_search?perPage=20
   Host: api.tracker.yandex.net
   Authorization: OAuth API_TOKEN
   Content-Type: application/json
   X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
   
   {
     "name": "Планы команды"
   }
   

2. Подставьте идентификатор последнего дашборда из ответа вместо LAST_DASHBOARD_ID и запросите следующую страницу:

   POST /v3/dashboards/_search?perPage=20&id=LAST_DASHBOARD_ID
   Host: api.tracker.yandex.net
   Authorization: OAuth API_TOKEN
   Content-Type: application/json
   X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
   
   {
     "name": "Планы команды"
   }
   

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

[
  {
    "id": 123,
    "self": "https://api.tracker.yandex.net/v3/dashboards/123",
    "version": 1,
    "name": "Планы команды",
    "layout": "one-column"
  }
]