An indicator drill allows you to further analyse an indicator. Indicator drill consists of an array of blocks. These blocks can be displayed either after clicking on an indicator, or directly on a dashboard.
...
| Code Block |
|---|
| title | Indicator drill object syntax |
|---|
|
{
"name": "customers_indicator_drill",
"type": "indicatorDrill",
"content": {
"blocks": [
{
"type": "distribution",
"title": "Optional distribution title",
"indicator": "/rest/projects/$projectId/md/indicators?name=online_turnover_indicator"
},
{
"type": "ranking",
"title": "Optional ranking title",
"indicator": "/rest/projects/$projectId/md/indicators?name=online_turnover_indicator"
},
{
"type": "timeSeries",
"title": "Optional time series title",
"indicator": "/rest/projects/$projectId/md/indicators?name=online_turnover_indicator"
},
{
"type": "categories",
"title": "Customers by channel",
"description": "Customers by channel",
"splitProperty": "baskets.on_off_name",
"orderBy": {
"property": "baskets.on_off_name",
"direction": "desc"
}
},
{
"type": "categories",
"title": "Customers by age and sex",
"description": "Customers by age and sex categories",
"splitProperty": "clients.age_name",
"orderBy": {
"property": "clients.age_cat",
"direction": "asc"
},
"dualProperty": "clients.sex_name",
"label": "Age categories"
}
]
}
}
|
...
Distribution also has a description, which is not configurable through metadata, but is compiled from the properties of its paired indicator, according to this formula: "Distribution of indicator.title in granularity"
| Key | Type | Optionality | Description | Constraints |
|---|
type | string | | type identifier, always distribution | [distribution] |
title | string | | human-readable title of the categories block | (*) |
indicator | string | | URL link to the indicator object | /rest/projects/$projectId/md/indicators?name={indicatorName} |
onDashboard | boolean | | determines if the block should be displayed directly on a dashboard | [true, false] |
| collapsed | boolean | | determines if the block should be collapsed when entering the view | [true, false]
|
...
Ranking also has a description, which is not configurable through metadata, but is compiled from the properties of its paired indicator, according to this formula: "Rank of object according to indicator.title" (note: object in this case is either a polygon from a certain granularity, or a marker).
| Key | Type | Optionality | Description | Constraints |
|---|
type | string | | type identifier, always ranking | [ranking] |
title | string | | human-readable title of the categories block | (*) |
indicator | string | | URL link to the indicator object | /rest/projects/$projectId/md/indicators?name={indicatorName} |
onDashboard | boolean | | determines if the block should be displayed directly on a dashboard | [true, false] |
featureType | string | | specifies which feature type should be ranked by default default = granularity | [granularity, markers] |
direction | string | | specifies the direction of ranked objects default = desc | [asc, desc] |
| collapsed | boolean | | determines if the block should be collapsed when entering the view | [true, false] |
...
Time series also has a description, which is not configurable through metadata, but is compiled from the properties of its paired indicator, according to this formula: "Progress of indicator.title from view.content.filterGroup.globalDate.startDate to view.content.filterGroup.globalDate.endDate"
| Key | Type | Optionality | Description | Constraints |
|---|
type | string | | type identifier, always timeSeries | [timeSeries] |
title | string | | human-readable title of the categories block | (*) |
indicator | string | | URL link to the indicator object | /rest/projects/$projectId/md/indicators?name={indicatorName} |
onDashboard | boolean | | determines if the block should be displayed directly on a dashboard | [true, false] |
defaultPeriod | string | | specifies the default period dataset selected by default | /rest/projects/$projectId/md/datasets?name={datasetName} |
additionalSeries | array | | array of additionalSeries objects |
|
annotations | array | | array of annotations objects |
|
| collapsed | boolean | | determines if the block should be collapsed when entering the view | [true, false] |
...