docs.intersystems.com
Home  /  Application Development: Analytics Options  /  Client-Side APIs for InterSystems Business Intelligence  /  Business Intelligence REST API  /  POST /Data/KPIExecute


Client-Side APIs for InterSystems Business Intelligence
POST /Data/KPIExecute
[Back]  [Next] 
InterSystems: The power behind what matters   
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:
Example Request
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.