Получить виджет

Запрос позволяет получить параметры виджета.

GET

https://api.tracker.yandex.net/v3/widgets/{id_виджета}

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

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

Чтобы получить параметры виджета, используйте HTTP-запрос с методом GET.

GET /v3/widgets/{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.

Тело ответа содержит JSON-объект с параметрами виджета.

Набор полей зависит от типа виджета. Ниже приведен пример ответа для filter. Поля раскладки возвращаются, если виджет размещен на дашборде.

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

{
    "id": 123456,
    "version": 1,
    "type": "filter",
    "self": "https://api.tracker.yandex.net/v3/widgets/123456",
    "column": 1,
    "row": 1,
    "coords": {"x": 0, "y": 0, "w": 6, "h": 8},
    "dashboard": {
        "self": "https://api.tracker.yandex.net/v3/dashboards/18",
        "id": "18",
        "display": "Новый дашборд"
    },
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v3/users/8000000000000007",
        "id": "11********",
        "display": "Имя Фамилия",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": 1100000000000000
    },
    "description": "new desc",
    "color": 0,
    "createdAt": "2026-08-27T10:34:30.363+0000",
    "fields": [
        {
            "self": "https://api.tracker.yandex.net/v3/fields/summary",
            "id": "summary",
            "name": "Задача",
            "key": "summary",
            "version": 0,
            "schema": {
                "type": "string",
                "required": true
            },
            "readonly": false,
            "options": false,
            "suggest": false,
            "queryProvider": {
                "type": "SummaryQueryProvider"
            },
            "order": 6,
            "category": {
                "self": "https://api.tracker.yandex.net/v3/fields/categories/000000000000000000000001",
                "id": "000000000000000000000001",
                "display": "Системные"
            },
            "type": "standard"
        }
    ],
    "perPage": 10,
    "filterParams": {
        "filter": {
            "author": "Автор"
        }
    }
}

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

Параметр	Описание	Тип данных
id	Идентификатор виджета.	Число
version	Версия виджета. Каждое изменение виджета увеличивает номер версии.	Число
type	Тип виджета.	Строка
self	Адрес ресурса API, который содержит параметры виджета.	Строка
dashboard	Объект с информацией о дашборде, на котором размещен виджет.	Объект
createdBy	Объект с информацией о создателе виджета.	Объект
description	Название виджета.	Строка
text	Текст заметки. Возвращается для виджета `note`.	Строка
column	Номер колонки, если виджет размещен в раскладке.	Число
row	Номер строки, если виджет размещен в раскладке.	Число
collapsed	Признак свернутого виджета, если он задан в раскладке.	Логический
coords	Координаты и размер, если они заданы в раскладке.	Объект
order	Порядок виджета, если он задан в раскладке.	Число
color	Служебный параметр.	Число
createdAt	Дата и время создания виджета в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`.	Строка
fields	Массив объектов с информацией о полях задач, отображаемых в виджете.	Массив объектов
perPage	Количество задач на одной странице виджета.	Число
filterParams	Параметры фильтрации задач для виджета.	Объект

Поля объекта coords

Параметр	Описание	Тип данных
x	Координата по горизонтали.	Число
y	Координата по вертикали.	Число
w	Ширина.	Число
h	Высота.	Число

Поля объекта dashboard

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

Поля объекта createdBy

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о пользователе.	Строка
id	Идентификатор пользователя.	Строка
display	Отображаемое имя пользователя.	Строка
passportUid	Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID.	Число
cloudUid	Уникальный идентификатор пользователя в Yandex Identity Hub.	Строка

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит параметры поля.	Строка
id	Идентификатор поля.	Строка
name	Название поля.	Строка
key	Ключ поля.	Строка
version	Версия поля.	Число
schema	Схема поля.	Объект
readonly	Признак того, что поле доступно только для чтения.	Логический
options	Признак того, что поле имеет фиксированный набор значений.	Логический
suggest	Признак того, что для поля доступны подсказки.	Логический
queryProvider	Провайдер запросов для поля.	Объект
order	Порядок отображения поля.	Число
category	Категория поля.	Объект
type	Тип поля.	Строка

Поля объекта schema

Параметр	Описание	Тип данных
type	Тип данных поля.	Строка
required	Признак того, что поле обязательно для заполнения.	Логический

Поля объекта queryProvider

Параметр	Описание	Тип данных
type	Тип провайдера запросов.	Строка

Поля объекта category

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

Поля объекта filterParams

Параметр	Описание	Тип данных
filter	Фильтр задач по параметрам.	Объект
query	Фильтр задач на языке запросов, если он задан.	Строка

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

400: Один или несколько параметров запроса имеют недопустимое значение.

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

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

500: Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

503: Сервис API временно недоступен.

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

Создать виджет

Обновить виджет