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


# Получить дашборд

Запрос возвращает параметры дашборда и ссылки на размещенные на нем виджеты.

<div class="request_example yfm-code-floating-container method_get">
    <p>GET</p>
    <pre><code>https://api.tracker.yandex.net/v3/dashboards/{id_дашборда}</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 translate=no
GET /v3/dashboards/{id_дашборда}
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
```

<!-- source: ru/api/_includes/headings-no-body.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/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-no-body.md -->

{% cut "Ресурс" %}

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| id_дашборда | Идентификатор дашборда. | Число ||
|#

{% endcut %}

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

{% list tabs %}

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

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

    При успехе API возвращает объект дашборда. Свойство `widgets` содержит массив ссылок на виджеты, а не их полные параметры.

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

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

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

    **Поля элементов массива** `widgets`

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || id | Идентификатор виджета. | Строка ||
    || self | Адрес ресурса API с параметрами виджета. | Строка ||
    || display | Название виджета. | Строка ||
    |#

    {% endcut %}

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

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

    <!-- source: ru/api/_includes/answer-error-403.md -->
    403
    :   У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
    <!-- endsource: ru/api/_includes/answer-error-403.md -->

    Нет доступа к дашборду.

    <!-- source: ru/api/_includes/answer-error-404.md -->
    404
    :   Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
    <!-- endsource: ru/api/_includes/answer-error-404.md -->

{% endlist %}