---
metadata:
  - name: generator
    content: Diplodoc Platform v5.70.0
  - property: og:type
    content: article
  - property: article:section
    content: Справочник API
  - property: og:title
    content: Найти дашборды
alternate:
  - https://yandex.ru/support/tracker/en/api/dashboards/search-dashboards.md
  - https://yandex.ru/support/tracker/ru/api/dashboards/search-dashboards.md
  - href: https://yandex.ru/support/tracker/ru/api/dashboards/search-dashboards.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/support/tracker/ru/llms.txt?revision=r22105730
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt?revision=r22105730


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

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

<div class="request_example yfm-code-floating-container method_post">
    <p>POST</p>
    <pre><code>https://api.tracker.yandex.net/v3/dashboards/_search</code></pre>
    <button class="yfm-clipboard-button"><svg width="16" height="16" viewBox="0 0 24 24" class="yfm-clipboard-icon" data-animation="15">
    <path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path>
    <path stroke="currentColor" fill="transparent" strokewidth="1.5" d="M9.5 13l3 3l5 -5" visibility="hidden">
        <animate id="visibileAnimation-15" attributeName="visibility" from="hidden" to="visible" dur="0.2s" fill="freeze" begin=""></animate>
        <animate id="hideAnimation-15" attributeName="visibility" from="visible" to="hidden" dur="1s" begin="visibileAnimation-15.end+1" fill="freeze"></animate>
    </path>
</svg>
</button>
</div>

<!-- source: ru/api/_assets/style/methods.md -->

<!-- endsource: ru/api/_assets/style/methods.md -->

## Формат запроса {#request}

Перед выполнением запроса [получите доступ к API](https://yandex.ru/support/tracker/ru/api/access.md). Передайте параметры поиска в JSON-теле запроса.

```json translate=no
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"}
}
```

<!-- source: ru/api/_includes/headings.md -->
{% cut "Заголовки" %}

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

* <!-- source: ru/api/_includes/authorization.md -->
  `Authorization`: токен для авторизации в одном из форматов:

    - `OAuth OAUTH_TOKEN` при авторизации по протоколу OAuth 2.0. [Читать подробнее](https://yandex.ru/support/tracker/ru/api/access.md#about_OAuth)

    - `Bearer IAM_TOKEN` при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. [Читать подробнее](https://yandex.ru/support/tracker/ru/api/access.md#iam-token)
  <!-- endsource: ru/api/_includes/authorization.md -->

* <!-- source: ru/api/_includes/content-type-json.md -->
  `Content-Type`: формат тела запроса. Должен иметь значение `application/json`.
  <!-- endsource: ru/api/_includes/content-type-json.md -->


* <!-- source: ru/api/_includes/org-id.md -->
  `X-Org-ID` или `X-Cloud-Org-ID`: идентификатор организации.

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

  - если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок `X-Cloud-Org-ID`.
  <!-- endsource: ru/api/_includes/org-id.md -->

  <!-- source: ru/api/_includes/org-id.md -->
  Чтобы узнать идентификатор организации, перейдите на страницу **Администрирование** → [**Организации**](https://tracker.yandex.ru/admin/orgs) и скопируйте значение поля **идентификатор**.
  <!-- endsource: ru/api/_includes/org-id.md -->


{% endcut %}
<!-- endsource: ru/api/_includes/headings.md -->

{% cut "Параметры запроса" %}

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

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| perPage | Максимальное число дашбордов на странице ответа. По умолчанию — 50. Значения больше 500 API уменьшает до 500. | Число ||
|| id | Идентификатор последнего дашборда на предыдущей странице. Передайте его, чтобы получить следующую страницу. | Число ||
|#

{% endcut %}

{% cut "Параметры тела запроса" %}

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| name | Часть названия дашборда для поиска. | Строка ||
|| owner | Владелец дашборда. Передайте объект со свойством `login`, `id` или другим поддерживаемым идентификатором пользователя. | Объект ||
|#

{% endcut %}

## Механизм пагинации {#pagination}

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

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

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

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

### Пример последовательных запросов {#pagination-example}

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

    ```json translate=no
    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": "Планы команды"
    }
    ```

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

    ```json translate=no
    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": "Планы команды"
    }
    ```

## Формат ответа {#response}

{% list tabs %}

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

    <!-- source: ru/api/_includes/answer-200.md -->
    В случае успешного выполнения запроса API возвращает ответ с кодом `200 OK`.
    <!-- endsource: ru/api/_includes/answer-200.md -->

    При успехе API возвращает массив дашбордов и заголовки пагинации.

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


    {% cut "Параметры ответа" %}

    Каждый элемент массива содержит параметры дашборда.

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || id | Идентификатор дашборда. | Число ||
    || self | Адрес ресурса API с параметрами дашборда. | Строка ||
    || version | Версия дашборда. | Число ||
    || name | Название дашборда. | Строка ||
    || createdBy | Создатель дашборда. [Поля объекта пользователя](https://yandex.ru/support/tracker/ru/api/dashboards/create-dashboard.md#user). | Объект ||
    || createdAt | Дата и время создания дашборда. | Строка ||
    || layout | Режим отображения виджетов. | Строка ||
    || temp | Признак временного дашборда. | Логический ||
    || owner | Владелец дашборда. [Поля объекта пользователя](https://yandex.ru/support/tracker/ru/api/dashboards/create-dashboard.md#user). | Объект ||
    |#

    {% endcut %}

    {% cut "Заголовки ответа" %}

    #|
    || **Заголовок** | **Описание** ||
    || Link | Ссылки на первую и следующую страницы результатов. ||
    || X-Total-Count | Общее число найденных дашбордов. ||
    || X-Total-Pages | Общее число страниц при выбранном `perPage`. ||
    |#

    {% endcut %}

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

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

    <!-- source: ru/api/_includes/answer-error-400.md -->
    400
    :   Один или несколько параметров запроса имеют недопустимое значение.
    <!-- endsource: ru/api/_includes/answer-error-400.md -->

    Некорректный параметр пагинации `id`.

{% endlist %}