Перейти к основному содержимому

GET /kpi

Выводит список показателей KPI.

Адрес: GET https://instance_name/api/data/v1.3/kpi/

Content-type: application/json

Параметры тела запроса


limit integer

Количество результатов, которые возвращаются в ответе.


offset integer

Начальный индекс, с которого возвращаются результаты.


Пример запроса

curl –i –X GET
https://test.inspector-cloud.com/api/data/v1.3/kpi/
-H ‘Authorization: Token <<your_token>>

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

Код ответа: 200

{
"count": 5,
"next": null,
"previous": null,
"results": [
{
"id": 11,
"cid": "% Shelf Share Linear Pet Food Home Shelf",
"name": "% Shelf Share Linear Pet Food Home Shelf",
"units": "%"
},
{
"id": 12,
"cid": "% Glass Facing Share Nescafe Classic",
"name": "Glass Facing Share Nescafe Classic",
"units": "%"
},
{
"id": 13,
"cid": "PU_GL_3",
"name": "PU_GL_3",
"units": null
},
{
"id": 14,
"cid": "PU_GL_2",
"name": "PU_GL_2",
"units": null
},
{
"id": 15,
"cid": "PU_GL_1",
"name": "PU_GL_1",
"units": null
}
]
}

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


count integer

Обязательный. Количество показателей.

next string (uri) Nullable

Следующая страница списка.


previous string (uri) Nullable

Предыдущая страница списка.


results Array of objects

Обязательный. Массив объектов с информацией о показателях.

id integer

Идентификатор показателя KPI.


cid string <= 255 символов Nullable

Идентификатор показателя KPI в системе пользователя.


name string <= 255 символов Nullable

Наименование показателя.


units string <= 255 символов Nullable