# Метрики

/api/metric методы.

## `DELETE /api/metric/:id`

Архивировать Метрику. (УСТАРЕЛО -- Вместо этого просто передайте обновленное значение `:archived` в метод `PUT`.).

### Параметры:

* **`id`** целое число больше нуля.

* **`revision_message`** непустая строка.

## `GET /api/metric/`

Получить все метрики.

## `GET /api/metric/:id`

Получить метрику по ID.

### Параметры:

* **`id`** целое число больше нуля.

## `GET /api/metric/:id/related`

Возвратить связанные сущности.

### Параметры:

* **`id`** целое число больше нуля.

## `GET /api/metric/:id/revisions`

Получить обновления `Revisions` для метрики по ID.

### Параметры:

* **`id`** целое число больше нуля.

## `POST /api/metric/`

Создать новую метрику.

### Параметры:

* **`name`** непустая строка.

* **`description`** строка или null.

* **`table_id`** целое число больше нуля.

* **`definition`** карта.

## `POST /api/metric/:id/revert`

Вернуть метрику в предыдущему пересмотру `Revision`.

### Параметры:

* **`id`** целое число больше нуля.

* **`revision_id`** целое число больше нуля.

## `PUT /api/metric/:id`

Обновить метрику с указанным ID.

### Параметры:

* **`points_of_interest`** строка или null.

* **`description`** строка или null.

* **`archived`** логическое значение или null.

* **`definition`** карта или null.

* **`revision_message`** непустая строка.

* **`show_in_getting_started`** логическое значение или null.

* **`name`** непустая строка или null.

* **`caveats`** строка или null.

* **`id`** целое число больше нуля.

* **`how_is_this_calculated`** строка или null.

## `PUT /api/metric/:id/important_fields`

Обновить важные поля `Fields` для метрики с указанным ID (используется в Руководстве по быстрому старту).

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

### Параметры:

* **`id`** целое число больше нуля.

* **`important_field_ids`** последовательность значений должна быть целым числом больше нуля.

---

[<< Назад к разделу API](./api-documentation.md)