Zidium

Получение истории значений метрик

Url запроса

http://ИмяВашегоАккаунта.api.zidium.net/1.0/GetMetricsHistory

Метод возвращает список значений метрик, соответствующих указанным критериям.
Незаполненные критерии не учитываются.
Метрики сортируются по убыванию даты начала, максимум можно получить 1000 метрик.

Запрос
{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "From": "2016-04-30T23:25:43.511Z",
        "To": "2016-04-30T23:25:43.511Z",
        "Name": "MetricTypeName",
        "MaxCount": 1000
    }
}

Здесь:

  • Token — раздел с токеном авторизации. В нём:
    • SecretKey (string) — секретный ключ аккаунта, посмотрите в личном кабинете;
  • ComponentId (guid) — Уникальный Id компонента, для которого ищутся метрики.
  • From (datetime) — Дата и время начала интервала поиска метрик. Необязательная.
  • To (datetime) — Дата и время окончания интервала поиска метрик. Необязательная.
  • Name (string) — Название типа метрики для поиска. Необязательное. Ищется по полному совпадению.
  • MaxCount (int) — Максимальное количество метрик в ответе. Необязательное. Не может быть больше 1000. Если не указано, будет равно 1000.

Ответ
{
    "Data": [
        {
            "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "Name": "MetricName",
            "Value": 100.5,
            "BeginDate": "2016-04-30T23:25:43.511Z",
            "ActualDate": "2016-04-30T23:25:43.511Z",
            "Status": "Success"
        },
        ...
    ]
    "Code": 10
}

Здесь:

  • ComponentId (guid) — Уникальный Id компонента.
  • Name (string) — Название метрики.
  • Value (double) — значение метрики. Может быть null.
  • BeginDate (datetime) — Дата начала значения.
  • ActualDate (datetime) — Дата актуальности значения.
  • Status (string) — Статус метрики. Может иметь значения: Success, Warning, Alarm, Disabled, Unknown.

Если компонент с указанным Id не существует, то Code будет равен 1100, а Data будет пустым.