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 Response
{
"Info": {"Error": "","KpiName": "DemoMDX"},
"Result": {
"Properties": [
{"name": "PatCount","caption": "PatCount","columnNo": 1},
{"name": "AvgTestScore","caption": "AvgTestScore","columnNo": 2}
],
"Series":
[
{"PatCount": 482,"AvgTestScore": 73.62564102564102564,"seriesName": "Cedar Falls"},
{"PatCount": 473,"AvgTestScore": 74.54089709762532982,"seriesName": "Centerville"},
{"PatCount": 454,"AvgTestScore": 73.86532951289398281,"seriesName": "Cypress"},
{"PatCount": 471,"AvgTestScore": 75.69459459459459459,"seriesName": "Elm Heights"},
{"PatCount": 468,"AvgTestScore": 74.00806451612903226,"seriesName": "Juniper"},
{"PatCount": 464,"AvgTestScore": 73.71925133689839572,"seriesName": "Magnolia"},
{"PatCount": 438,"AvgTestScore": 73.76123595505617978,"seriesName": "Pine"},
{"PatCount": 464,"AvgTestScore": 75.46537396121883657,"seriesName": "Redwood"},
{"PatCount": 445,"AvgTestScore": 75.19886363636363636,"seriesName": "Spruce"}
]
}
}
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 Notes on the Response Objects.
