POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
Description
The only parameter (body) is a JSON array containing the parameters. The parameters are described below:
JSON Array Parameter |
Description |
Allowable Values/Formats |
---|---|---|
granularity |
The desired granularity. |
|
period |
The period of interest, specified as either a date range, or one of the predefined names. |
|
timeRange |
The time window of interest on each day. |
|
aggregate |
Aggregate the dwell time by granularity, for example, showing the total dwell time for each day of the week, instead of individual dates. |
|
areas |
The list of areas of interest. If none are provided, all are considered. | A comma-separated list of area IDs, or hierarchy 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). |
|
connectionState |
Whether to restrict connection to either connected or detected devices (default=all). |
|
percentageOf |
If set this parameter, does not report absolute numbers, only relative percentage. | Heterarchy level |
dwellLimits |
The dwell time limit that specifies how dwellers should be grouped together. Pass -1 to catch all. Example: Light: 100, Medium: 200, Heavy:-1. |
|
areaFilter |
If set this parameter, restricts the results to areas
matching the filter. Use descendantOf to restrict the area selection. This
option is used for drill-down reports. Use 'subsetOf' to restrict the
granularity. This option is used with tag granularity.
For example: descendantOf: Campus C1 has Building B1 which zone Z1 and Z2 Campus C2 has Building B2 which zone Z3 query area=Z1,Z2,Z3 and granularity=Building and areaFilter=descendantOf:C1 will return only Building B1 For example: subsetOf: Tag T1,T2 assigned to F1, T2,T3 to F2, T3,T4 to F3 query area=F1,F2,F3 and granularity=tag and areaFilter=subsetOf:T1,T2 will return only T1,T2. |
|
expandAll |
Include all the elements descendants in the result. |
|
HTTP Method
POST
Resource URI
/api/analytics/v1/dwellBreakdown
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",
"granularity": "hourly",
"areas": "52,75"
}
Sample Output (JSON)
{
"startTime": "00:00",
"startDate": "2017-03-16",
"results": [
{
"id": 53,
"ancestry": [
{
"level": "Building",
"name": "REQ"
},
{
"level": "Campus",
"name": "Richfield"
}
],
"series": [
"datetime",
"dwell"
],
"hasChildren": false,
"area": "2nd Floor",
"data": []
},
{
"id": 75,
"ancestry": [
{
"level": "Floor",
"name": "Site 4"
},
{
"level": "Building",
"name": "Site 4"
},
{
"level": "Campus",
"name": "San Jose Outdoor"
}
],
"series": [
"datetime",
"dwell"
],
"hasChildren": false,
"area": "f4:0f:1b:1a:82:90",
"data": []
}
],
"interval": "hourly",
"executionTime": 0,
"insights": {
"summary": {}
},
"endDate": "2017-03-16",
"maxValues": {},
"endTime": "23:59",
"dataFreshness": "2017-03-16T02:53:58.054-07:00",
"minValues": {}
}