KPI

methods allow you to get a list of portal kpis or information on a specific kpi get get /kpi return a list of kpis { "tab" "request", "url" "https //instance name/api/data/v1 0/kpi/", "name" "request example", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "limit", "type" "integer", "description" "the number of results to return per page " }, { "kind" "optional", "name" "offset", "type" "integer", "description" "the initial index from which to return the results " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "fj3zsbaijz6tuvfi40xny", "code" "{\n \\"count\\" 5,\n \\"next\\"\ null,\n \\"previous\\"\ null,\n \\"results\\" \[\n {\n \\"id\\" 11,\n \\"cid\\" \\"% shelf share linear pet food home shelf\\",\n \\"name\\" \\"% shelf share linear pet food home shelf\\",\n \\"units\\" \\"%\\"\n },\n {\n \\"id\\" 12,\n \\"cid\\" \\"% glass facing share nescafe classic\\",\n \\"name\\" \\"glass facing share nescafe classic\\",\n \\"units\\" \\"%\\"\n },\n {\n \\"id\\" 13,\n \\"cid\\" \\"pu gl 3\\",\n \\"name\\" \\"pu gl 3\\",\n \\"units\\"\ null\n },\n {\n \\"id\\" 14,\n \\"cid\\" \\"pu gl 2\\",\n \\"name\\" \\"pu gl 2\\",\n \\"units\\"\ null\n },\n {\n \\"id\\" 15,\n \\"cid\\" \\"pu gl 1\\",\n \\"name\\" \\"pu gl 1\\",\n \\"units\\"\ null\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "fj3zsbaijz6tuvfi40xny" }, "examples" { "languages" \[ { "id" "dpmodah zaotktusexn5x", "code" "curl –i –x get\n https //test eyrene com/api/data/v1 1/kpi/\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "dpmodah zaotktusexn5x" }, "description" "get /kpi", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1/agents/agents list#response definitions count integer the number of kpis next string (uri) nullable nullable next page previous string (uri) nullable nullable previous page results array of objects an array of objects with information about kpi's id integer kpi id cid string <= 255 characters nullable <= 255 characters nullable kpi id in the user system name string \[ 1 255 ] \[ 1 255 ] characters characters kpi name units string <= 255 characters nullable <= 255 characters nullable kpi indicator unit get get /kpi/{id} returns information about kpi by id { "tab" "request", "url" "https //instance name/api/data/v1 0/kpi/{id}", "name" "request example", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "kpi id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "fj3zsbaijz6tuvfi40xny", "code" "{\n \\"id\\" 11,\n \\"cid\\" \\"% shelf share linear pet food home shelf\\",\n \\"name\\" \\"% shelf share linear pet food home shelf\\",\n \\"units\\" \\"%\\"\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "fj3zsbaijz6tuvfi40xny" }, "examples" { "languages" \[ { "id" "dpmodah zaotktusexn5x", "code" "curl –i –x get\n https //test eyrene com/api/data/v1 1/kpi/11/\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "dpmodah zaotktusexn5x" }, "description" "get /kpi/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response parameters id integer kpi id cid string <= 255 characters nullable <= 255 characters nullable kpi id in the user system name string \[ 1 255 ] \[ 1 255 ] characters characters kpi name units string <= 255 characters nullable <= 255 characters nullable kpi indicator unit