KPI Value Endpoint Documentation

This endpoint returns data related to a KPI instance.

This endpoint handles an HTTP GET request and returns data as xml.

This endpoint has several modes, each mode returns data in a different format.

Parameter	Usage	Type	Description
DatabaseName	Required	string	The name of the database to use for this request. The list of available databases is defined in web.config and can be retrieved here.
mode	Required	string	One of the following: getlist, getkpiinstance, gettrendimage, getdblist getlist: returns a DataListLoadReply xml document that contains a list of available KPI instances for the current user. getdblist: returns a list of available databases. Same list as here. getkpiinstance: returns a KpiInstanceGetStatusReply xml document that contains the information about the KPI instance with the given ID. gettrendimage: returns a byte stream that is an image that includes the graph,icon, and KPI meter indicator.
KpiInstanceID	Required when mode=gettrendimage or mode=getkpiinstance.	GUID	The ID of a KPI Instance record.

Parameter

Usage

Type

Description

DatabaseName

Required

string

The name of the database to use for this request. The list of available databases is defined in web.config and can be retrieved here.

mode

Required

string

One of the following: getlist, getkpiinstance, gettrendimage, getdblist

getlist: returns a DataListLoadReply xml document that contains a list of available KPI instances for the current user.

getdblist: returns a list of available databases. Same list as here.

getkpiinstance: returns a KpiInstanceGetStatusReply xml document that contains the information about the KPI instance with the given ID.

gettrendimage: returns a byte stream that is an image that includes the graph,icon, and KPI meter indicator.

KpiInstanceID

Required when mode=gettrendimage or mode=getkpiinstance.

GUID

The ID of a KPI Instance record.