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

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

GET

https://api.tracker.yandex.net/v3/dashboards/{id_дашборда}

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

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

GET /v3/dashboards/{id_дашборда}
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ

Заголовки

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

Ресурс

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

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

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

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

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

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

{
  "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"}
  ]
}

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

Параметр	Описание	Тип данных
id	Идентификатор дашборда.	Число
self	Адрес ресурса API с параметрами дашборда.	Строка
version	Версия дашборда. Передавайте ее при изменении дашборда.	Число
name	Название дашборда.	Строка
createdBy	Создатель дашборда. Поля объекта пользователя.	Объект
createdAt	Дата и время создания дашборда.	Строка
layout	Режим отображения виджетов.	Строка
widgets	Ссылки на виджеты дашборда. Если список пуст, поле отсутствует.	Массив объектов
temp	Признак временного дашборда.	Логический
owner	Владелец дашборда. Поля объекта пользователя.	Объект

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

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

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

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

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

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

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

Копировать дашборд

Обновить дашборд