POST /Data/KPIExecute - Tools for Creating DeepSee Web Clients

docs.intersystems.com

Tools for Creating DeepSee Web Clients

POST /Data/KPIExecute

[Home] [Back] [Next]

InterSystems: The power behind what matters

InterSystems DeepSee > Tools for Creating DeepSee Web Clients > DeepSee REST API > POST /Data/KPIExecute

Search:

Execute the query defined by a KPI.

URL Parameters

None. Note that a request body is required; see the next heading.

Request Body Details

This service uses the following properties of the request body:

KPI	Required. Logical name of the KPI.
FILTERS	Optional. Array of filter objects that specify how the KPI is filtered. Each filter object must provide the following properties: name — a filter specification such as [aged].[h1].[age group] value — logical name of a member of a filter, such as &[0 to 29]

Example Request

Request Method:

POST
Request URL:

http://localhost:57772/api/deepsee/v1/Data/KPIExecute

For comments on the possible forms of the URL, see “Introduction to the DeepSee REST API” in the chapter “Introduction and Samples.”

Request Body:

{
  "KPI": "DemoMDX",
  "FILTERS": [ {"name" : "[aged].[h1].[age group]","value" : "&[0 to 29]" } ] 
}

Example Response

{
   "Info":{"Error":"","KpiName":"DemoMDX"},
   "Result":
      {"Series":
         [
          {"PatCount":49,"AvgTestScore":77.14705882352941176},
          {"PatCount":46,"AvgTestScore":77.41025641025641026},
          {"PatCount":40,"AvgTestScore":74.37931034482758621},
          {"PatCount":45,"AvgTestScore":74.59459459459459459},
          {"PatCount":53,"AvgTestScore":71.2},
          {"PatCount":51,"AvgTestScore":74.05},
          {"PatCount":44,"AvgTestScore":75.66666666666666667},
          {"PatCount":48,"AvgTestScore":74.86486486486486486},
          {"PatCount":42,"AvgTestScore":74}
          ],
        "Properties":
          [
           {"name":"PatCount","caption":"PatCount","columnNo":1},
           {"name":"AvgTestScore","caption":"AvgTestScore","columnNo":2}
          ]
      }
}

In the response object, the Result property contains the properties Series and Properties. The Series property contains an array of objects, one for each series (or row) in the KPI. The Properties property contains an array of objects, one for each row in the KPI.

For information that applies to all response objects, see the discussion at the start of this reference.