Overview API
POST: Overview Data for Target Areas for Brochure View
Description
This task retreives overview Data for Target Areas for Brochure View
|
JSON body parameter |
Description |
Allowable values/formats |
|---|---|---|
|
type |
The type of data requested |
|
|
period |
The period of interest, either specified as a date range, or one of the predefined names |
|
|
timeRange |
The time window of interest on each day |
|
|
areas |
The list of areas of interest. If none are given, all are considered | A comma-separated list of area ids, or heterarchy levels |
|
durationCategories |
Filter devices by dwell times for which device visits specified areas. If a device's dwell time falls outside of the range, it is filtered out and not considered a visit. | Time (in minutes) in the form nn-mm where nn is the lower limit and mm the upper limit. The maximum upper limit is 1440 minutes;
which is 24 hours, or a full day. Accepted Values:
|
|
includeStationary |
Whether to include stationary devices (default=false) |
|
|
entirePeriod |
Whether to include device visits that occur any time during
the entire period or only within a single day (default=false).
Applicable only to crossover; ignored for the other metrics. |
|
|
connectionState |
Whether to restrict to either connected or detected devices
(default=all).
For Connected/Detected metric, this setting is ignored, and "all" is presumed |
|
|
percentageOf |
If set, does not report absolute numbers, but relative percentage. Ignored for Crossover report | Heterarchy level |
|
dwellLimits |
The dwell time limits that specifies how dwellers should be grouped together. Values are comma seperated as key:value pairs.
Key is the series name and value is the upper dwell time limit of the series.
For example, Light:5,Medium:20,Heavy:100 would mean that you consider devices that dwell for less than 5 minutes to be Light; from 5 minutes to 20 minutes to be Medium; and from 20 minutes to 100 to be Heavy. If you want to consider all dwells, pass in -1 as the value. |
|
HTTP Method
POST
Resource URI
/api/analytics/v1/overview
Requires Basic Auth
N
Parameters
|
Name |
Required |
Default |
Type |
Location |
Description |
|---|---|---|---|---|---|
|
body |
Y |
— |
JSON array |
body |
JSON array containing parameters |
Content Type
application/json
Sample Input (JSON)
{
"period": "today",
"timeRange": "00:00-23:59",
"areas": "52",
"type": "deviceCount"
}Sample Output (JSON)
{
"startTime": "00:00",
"previousEndDate": null,
"startDate": "2017-03-16",
"title": "Visitors",
"executionTime": 32,
"value": {
"primary": {
"title": "Total Visitors",
"value": 0,
"peakValue": 0,
"breakdown": [
{
"title": "Repeat Visitors",
"value": 0
},
{
"title": "New Visitors",
"value": 0
}
]
},
"average": {
"title": "Total Visitors",
"value": 0,
"peakValue": 0,
"breakdown": [
{
"title": "Repeat Visitors",
"value": 0
},
{
"title": "New Visitors",
"value": 0
}
]
},
"previousTimeRange": {
"title": "Total Visitors",
"value": 0,
"peakValue": 0,
"breakdown": [
{
"title": "Repeat Visitors",
"value": 0
},
{
"title": "New Visitors",
"value": 0
}
]
}
},
"areas": [
{
"id": 52,
"name": "f0:25:72:3c:f8:10"
}
],
"previousStartDate": "2017-03-15",
"endDate": null,
"endTime": "23:59"
}
Feedback