Metric Chart Reports
This category includes the following reports:
-
Four Metric Summary
-
Six Metric Summary
And the following report templates:
-
Four Metric Summary
-
Six Metric Summary
-
RPAS Four Metric Summary
-
RPAS Six Metric Summary
The REST service should return a JSON object with the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
|
items |
Array |
Y |
An array of Metric Item objects to display on the tile. Up to six metric items may be returned; some reports will display fewer. |
|
chart |
Object |
N |
A Metric Chart object defining a chart to be displayed below the metrics. |
Example response payload for Two Metric Summary:
{
"items": [{
"name": "Metric 1",
"value": 10000,
"valueFormat": "S"
}, {
"name": "Example",
"value": 0.5,
"valueFormat": "PC"
}],
"chart": {
"type": "bar",
"items": [{
"name": "JAN",
"seriesName": "2021",
"value": 4300000
}, {
"name": "FEB",
"seriesName": "2021",
"value": 2230000
}, {
"name": "JAN",
"seriesName": "2022",
"value": 3500000
}, {
"name": "FEB",
"seriesName": "2022",
"value": 4500000
}
],
"renderTooltips": true,
"valueFormat": "S",
"renderXAxisLabels": true,
"renderYAxisLabels": true
}
}