Skip to main content

GET /kpi

Returns a list of KPI's.

Address: GET https://instance_name/api/data/v1.3/kpi/

Content-type: application/json

Request body parameters

limit integer

Number of results to return per page.

offset integer

The initial index from which to return the results.

Request example

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

Response example

Response code: 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
    }
  ]
}

Response definitions

count integer

Required. Number of KPI's.

next string (uri) Nullable

Next page.

previous string (uri) Nullable

Previous page.

results Array of objects

Required. Array of objects with information about KPI.

id integer

KPI ID.

cid string <= 255 characters Nullable

name string <= 255 characters Nullable

KPI name.

units string <= 255 characters Nullable