Изменить метрики сущности

Для работы с метриками в проектах, портфелях и целях используется параметр сущности metricItems.

См. подробнее:

• Дополнительные параметры сущности.
• Метрики в проекте.

Добавить или изменить метрики

Чтобы добавить или изменить список метрик в проекте, портфеле или цели, используйте запрос Изменить сущность. В теле запроса передайте объект fields с вложенным массивом metricItems: см. Дополнительные параметры сущности.

Параметры объектов массива metricItems

Пример 1: Добавить в цель две метрики. Если в цели уже есть метрики, они будут заменены новыми.

PATCH /v3/entities/goal/655f328********?fields=metricItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
 "fields": {
   "metricItems": [
     {
       "text": "First metric",
       "url": "https://tracker.yandex.ru/dashboard/12/widget/34?_embedded=1&_no_controls=1"
     },
     {
       "text": "Second metric",
       "url": "https://tracker.yandex.ru/dashboard/23/widget/45?_embedded=1&_no_controls=1"
     }
   ]
 }
}

Пример 2: Добавить к существующим метрикам проекта одну новую.

PATCH /v3/entities/project/655f8cc52*****?fields=metricItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
 "fields": {
   "metricItems": {
     "add": {
       "text": "My metric",
       "url": "https://tracker.yandex.ru/dashboard/12/widget/34?_embedded=1&_no_controls=1"
     }
   }
 }
}

Получить метрики сущности

Чтобы получить метрики проекта, портфеля или цели, используйте запрос Получить параметры сущности с параметром fields=metricItems:

GET https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>?fields=metricItems

Параметры массива ключевых результатов metricItems приведены в разделе Дополнительные параметры сущности.

Удалить метрики

Для удаления метрик проекта, портфеля или цели используйте запрос Изменить сущность:

• Чтобы удалить все метрики, передайте значение "metricItems": null.
• Чтобы удалить одну или несколько метрик, обновите список (см. Добавить или изменить метрики) или используйте оператор remove.

Пример 1. Удалить все метрики цели.

PATCH /v3/entities/goal/655f328********?fields=metricItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
 "fields": {
       "metricItems": null
   }
}

Пример 2. Удалить одну метрику из списка.

PATCH /v3/entities/project/655f8cc52*****?fields=metricItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "fields": {
     "metricItems": {
         "remove": {
             "id": "6789*******",
             "text": "My metric",
             "url": "https://tracker.yandex.ru/dashboard/12/widget/34?_embedded=1&_no_controls=1"
         }
     }
  }
}