Cisco Connected Mobile Experiences REST API Guide, Release 10.
2
First Published: April 21, 2015
Last Modified: March 31, 2016
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version
of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://
www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)
2015
Cisco Systems, Inc. All rights reserved.
CONTENTS
CHAPTER 1
Preface 1
Audience 1
Conventions 1
Related Documentation 2
Obtaining Documentation and Submitting a Service Request 2
CHAPTER 2
Analytics 3
GET: Summary of Count of SMA 4
GET: Details of SMA Count with Summary Type 6
GET: All Summary Count of SMA with Hashtags 8
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas 10
POST: Paths for a Given Period and Areas 14
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas 16
GET: All summary KPI 20
GET: Specific set of Summary KPIs or a list of available ones 21
POST: Breakdown of Connected and Detected Devices for a Given Period and Areas 22
GET: Alerts for Device Count for a single Heterarchy Element and Time Frame 25
GET: Alerts for Device Count for a single Heterarchy Element 26
GET: Retrieves Alerts for Device Count 27
POST: Queue Time for a Given Period and Areas 28
POST: Overview Data for Target Areas for Brochure View 31
POST: Dwell Time for a Given Period and Areas 34
POST: Device Count for a Given Period and Areas 38
CHAPTER 3
Configuration 43
GET: Get Supported Northbound Notifications 46
GET: Current CMX Image Version 47
GET: Count of Active Alerts 48
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
iii
Contents
GET: All Alerts 49
POST: Add Role to User 50
DELETE: Role from User 51
GET: All Users in the System 52
POST: Create a User 53
POST: Modify User 54
GET: User by Username 55
DELETE: User by Username 56
GET: All Roles 57
GET: All Campuses 58
GET: Campus by Name 59
PUT: Add Campus 60
GET: Count of All Map Elements 61
GET: List of all Building Names. 62
GET: List of all Building Names 63
GET: List of all Floor Names 64
GET: List of all Floor Names 65
GET: All Maps 66
GET: Campus by Name 67
GET: Building by Name Inside Specific Campus 68
GET: Floor Inside Specific Building and Specific Campus 69
GET: Floor Image 70
GET: Image by Name 71
GET: All Sites 72
GET: Site Details by ID or Name 73
GET: System Settings 74
PUT: System Settings 75
GET: All Notification Subscriptions 76
GET: Notifications by Name 77
GET: Notification Subscription Availability 78
PUT: Add Notification Subscription 79
PUT: List of Notification Subscriptions 82
DELETE: Notification Subscription 83
GET: System Alert Subscription 84
GET: Notifications by Name 85
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
iv
Contents
PUT: System Alert Subscription 86
PUT: List of System Alert Subscriptions 89
DELETE: Notification Alert Subscription 90
POST: Change Status of Notification by Name 91
GET: Unique Alerts by Time Interval 92
GET: Alert by Time Interval 93
GET: Alerts by Time Interval and Hashkey 94
GET: Total Alerts Created for a Given Alert Key 95
GET: All APs 96
GET: Access Point by MAC Address 97
GET: Settings for a Given User 98
PUT: Setting for a Given User 99
GET: All Cisco WLC Controllers 100
GET: Get Cisco WLC Controllers by IP address 101
PUT: Controller 102
POST: Devices to the opt-out List 104
DELETE: List of Devices from Opt-out 105
DELETE: All opt-out Devices 106
GET: List of Opt-out Devices Within a Date Range 107
GET: Count of opt-out Devices 108
DELETE: Opt-out Devices Within a Date Range 109
GET: List of Children Superzone IDs of a Hiterarchy Element 110
GET: Children Superzone IDs of Hiterarchy Element 112
CHAPTER 4
Connect 113
GET: Query User Sessions 114
CHAPTER 5
Location 117
GET: Active Tags Count 118
GET: All Tags 119
GET: Tag by MAC Address 120
GET: Supported Northbound Notifications 121
GET: Count of all the Beacons 122
PUT: Place a Beacon at Detected Location on Map 123
PUT: Updates Name of a Given Beacon 124
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
v
Contents
GET: List of Beacons Matching Filter Criteria 125
POST: Add Beacon with Minimum Fields 126
GET: Beacons with Minimum Information for a Floor ID 127
GET: List of Beacons 128
GET: Beacon by MAC Address 129
DELETE: Delete Beacon by MAC Address 130
PUT: Update Beacon 131
GET: List of Beacons Present on a Floor 133
POST: Add Beacon to the Store 134
GET: Active Clients Count 136
GET: All clients 137
GET: Collection of Active Clients MAC Address 138
GET: Compact History of Client by Date and Username 139
GET: Unique MAC Address Seen on a Given Day on a Floor or Zone 140
GET: Compact History of Client By Date and IPv4 Address 142
GET: This API returns history for all clients 143
GET: History of Client by MAC Address 144
CHAPTER 6
Presence 145
GET: Count of Passersby Today 149
GET: Count of Passersby Yesterday 150
GET: Average Count of Passersby in Last 3 Days 151
GET: Average Count of Passersby in the Last 7 days 152
GET: Average Count of Passersby in the Last 30 Days 153
GET: Sum of Passerby Counts in the Specified Date Range 154
GET: Sum of Passerby Counts in the Last 3 Days 155
GET: Sum of Passerby Counts in the Last 7 Days 156
GET: Count of Passersby on a Given Date 157
GET: Sum of Passerby Counts in the Last 30 days 158
GET: Hourly Count of Passersby Today 159
GET: Hourly Count of Passersby Yesterday 160
GET: Hourly Count of Passersby for Last 3 days 161
GET: Hourly Count of Passersby for a Day 162
GET: Daily Count of Passersby for a Specified Date Range 163
GET: Daily Count of Passersby for the Last 7 days 164
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
vi
Contents
GET: Daily count of passersby for the last 30 days 165
GET: Daily Count of Passersby by hour for the Specified Date Range 166
GET: Excluded Client Counts 167
GET: Active Clients 168
GET: Client Detail 169
GET: Count of Connected Visitors for a Date 170
GET: Count of Connected Visitors Seen today Until Now 171
GET: Count of Connected Visitors Seen Yesterday 172
GET: Average Count of Connected Visitors Seen in Last 3 Days 173
GET: Average Count of Connected Visitors Seen in Last 7 Days 174
GET: Average Count of Connected Visitors seen in last 30 Days 175
GET: Sum of Connected Visitor Counts in Last 3 days 176
GET: Sum of Connected Visitor Counts in Last 7 days 177
GET: Sum of Connected Visitor Counts in Last 30 days 178
GET: Sum of Connected Visitor Counts in the Specified Date Range 179
GET: Hourly Count of Connected Visitors Today 180
GET: Hourly Count of Connected Visitors Yesterday 181
GET: Hourly Count of Connected Visitors in Last 3 Days 182
GET: Hourly Count of Connected Visitors for the Specified Day 183
GET: Daily Count of Connected Visitors for the Specified Date Range 184
GET: Daily Count of Connected Visitors for Last 7 days 185
GET: Daily Count of Connected Visitors for last 30 Days 186
GET: Daily Count of Connected Visitors by Hour for the Specified Date Range 187
GET: Site KPI Summary for Specified Date or Date Range 188
GET: Site KPI Summary for Today 189
GET: Site KPI Summary for Yesterday 190
GET: Site KPI Summary for Last 3 Days 191
GET: Site KPI Summary for last 7 days 192
GET: Site KPI Summary for Last 30 Days 193
GET: Site Insights for Specified Date or Date Range 194
GET: Average Count of Repeat Visitors for Last 7 Days 195
GET: Average Count of Repeat Visitors for Last 30 days 196
GET: Sum of Repeat Visitor Counts for Last 3 days 197
GET: Sum of Repeat Visitor Counts for Last 7 days 198
GET: Sum of Repeat Visitor Counts for Last 30 days 199
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
vii
Contents
GET: Hourly Count of Repeat Visitors for a Day 200
GET: Hourly Count of Repeat Visitors Today 201
GET: Hourly Count of Repeat Visitors Yesterday 202
GET: Count of Repeat Visitors for a Date or Date Range 203
GET: Count of Repeat Visitors for Today 204
GET: Count of Repeat Visitors for Yesterday 205
GET: Average Count of Repeat Visitors for Last 3 days 206
GET: Average Count of Repeat Visitors for Specified Date Range 207
GET: Hourly Count of Repeat Visitors for Last 3 Days 208
GET: Repeat Visitor Summary for a Day 209
GET: Repeat Visitor Summary for a Week 210
GET: Repeat Visitor Summary for a Month 211
GET: Daily Count of Repeat Visitors for Specified Date Range 212
GET: Daily Count of Repeat Visitors for Last 7 Days 213
GET: Daily Count of Repeat Visitors for Last 30 days 214
GET: Peak Hour of Visitors Today 215
GET: Count of Visitors Today 216
GET: Count of Visitors Yesterday 217
GET: Count of Unique Visitors for Last 3 Days 218
GET: Count of Unique Visitors for Last Week 219
GET: Count of Unique Visitors for Last Month 220
GET: Count of Unique Visitors for a Date/Date Range 221
GET: Sum of Visitor Counts for a Date Range 222
GET: Sum of Visitor Counts for the Last 3 Days 223
GET: Sum of Visitor Counts for the Last Week 224
GET: Sum of Visitor Counts for the Last Month 225
GET: Hourly Count of Visitors Today 226
GET: Hourly Count of Visitors Yesterday 227
GET: Hourly Count of Visitors for Last 3 Days 228
GET: Hourly Count of Visitors for a Day 229
GET: Daily Count of Visitors for a Date Range 230
GET: Daily Count of Visitors for Last Week 231
GET: Daily Count of Visitors for Last Month 232
GET: Daily Count of Visitors by Hour Category for a Date Range 233
GET: Visitor Summary for a Day 234
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
viii
Contents
GET: Visitor Summary for Week 235
GET: Visitor Summary for Month 236
GET: Count of Visitors by Dwell Level for a Date or Date Range 237
GET: Count of Visitors by Dwell Level for Today 238
GET: Count of Visitors by Dwell Level for Yesterday 239
GET: Count of Visitors by Dwell Level for Last 3 Days 240
GET: Count of Visitors by Dwell Level for Last 7 Days 241
GET: Count of Visitors by Dwell Level for Last 30 Days 242
GET: Average Count of Visitors by Dwell Level for Last 7 Days 243
GET: Average Count of Visitors by Dwell Level for Last 30 Days 244
GET: Hourly Count of Visitors by Dwell Level for a Specific Day 245
GET: Hourly Count of Visitors by Dwell Level for Today 246
GET: Average Visitor Dwell Time by Dwell Level for Last 7 Days 247
GET: Average Visitor Dwell Time by Dwell Level for Last 30 Days 248
GET: Daily Average Visitor Dwell Time by Dwell Level for a Specific Date Range 249
GET: Daily Average Visitor Dwell Time by Dwell Level for Last 7 Days 250
GET: Daily Average Visitor Dwell Time by Dwell Level for Last 30 Days 251
GET: Hourly Count of Visitors by Dwell level for Yesterday 252
GET: Hourly Count of Visitors by Dwell Level for Last 3 Days 253
GET: Daily Count of Visitors by Dwell Level for a Specific Date Range 254
GET: Daily Count of Visitors by Dwell Level for Last 7 Days 255
GET: Daily Count of Visitors by Dwell Level for Last 30 Days 256
GET: Average Visitor Dwell Time for the Specific Date or Date Range 257
GET: Average Visitor Dwell Time for Today 258
GET: Average Visitor Dwell Time for Yesterday 259
GET: Average Visitor Dwell Time for Last 3 Days 260
GET: Average Visitor Dwell Time for Last 7 Days 261
GET: Average Visitor Dwell Time for Last 30 Days 262
GET: Average Visitor Dwell Time by Dwell Level for a Specific Date or Date Range 263
GET: Average Visitor Dwell Time by Dwell Level for Today 264
GET: Average Visitor Dwell Time by Dwell Level for Yesterday 265
GET: Average Visitor Dwell Time by Dwell Level for Last 3 days 266
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
ix
Contents
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
x
Preface
Audience, page 1
Conventions, page 1
Related Documentation, page 2
Obtaining Documentation and Submitting a Service Request, page 2
Audience
This document is for network administrators who configure Cisco Connected Mobile Experiences (Cisco
CMX) services.
Conventions
This document uses the following conventions:
Table 1: Conventions
Convention
Indication
bold font
Commands and keywords and user-entered text appear in bold font.
italic font
Document titles, new or emphasized terms, and arguments for which you supply
values are in italic font.
[]
Elements in square brackets are optional.
{x | y | z }
Required alternative keywords are grouped in braces and separated by vertical
bars.
[x|y|z]
Optional alternative keywords are grouped in brackets and separated by vertical
bars.
string
A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.
courier
font
Terminal sessions and information the system displays appear in courier font.
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
1
Preface
Related Documentation
Note
Tip
Caution
Convention
Indication
<>
Nonprinting characters such as passwords are in angle brackets.
[]
Default responses to system prompts are in square brackets.
!, #
An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.
Means reader take note. Notes contain helpful suggestions or references to material not covered in the
manual.
Means the following information will help you solve a problem.
Means reader be careful. In this situation, you might perform an action that could result in equipment
damage or loss of data.
Related Documentation
For more information about Cisco Mobility Services Engine and related products, see:
http://www.cisco.com/c/en/us/support/wireless/mobility-services-engine/tsd-products-support-series-h
For more information about Cisco Connected Mobile Experiences (Cisco CMX), see:
http://www.cisco.com/c/en/us/solutions/enterprise-networks/connected-mobile-experiences/index.html
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service
request, and gathering additional information, see What's New in Cisco Product Documentation.
To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the What's
New in Cisco Product Documentation RSS feed. RSS feeds are a free service.
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
2
Analytics
GET: Summary of Count of SMA, page 4
GET: Details of SMA Count with Summary Type, page 6
GET: All Summary Count of SMA with Hashtags, page 8
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas, page 10
POST: Paths for a Given Period and Areas, page 14
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas, page 16
GET: All summary KPI, page 20
GET: Specific set of Summary KPIs or a list of available ones, page 21
POST: Breakdown of Connected and Detected Devices for a Given Period and Areas, page 22
GET: Alerts for Device Count for a single Heterarchy Element and Time Frame, page 25
GET: Alerts for Device Count for a single Heterarchy Element, page 26
GET: Retrieves Alerts for Device Count, page 27
POST: Queue Time for a Given Period and Areas, page 28
POST: Overview Data for Target Areas for Brochure View, page 31
POST: Dwell Time for a Given Period and Areas, page 34
POST: Device Count for a Given Period and Areas, page 38
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
3
Analytics
GET: Summary of Count of SMA
GET: Summary of Count of SMA
Description
Retrieve the summary of Social Media Analytics (SMA) count with the details of the Summary types:
POSITIVES, NEGATIVES, PHOTOS, NEUTRAL, TOTAL, REPOSTS.
HTTP Method
GET
Resource URI
/api/analytics/v1/sma/summarycounts
Requires OAuth
N
Parameters
Table 2: Parameter Details
Name
Required
Default
Type
Location
Description
location
String
query
Location IDs for Social Media
Analytics. Allowed values or formats
include the location IDs of buildings
or campuses.
dailyHours
String
query
Hours of a day, specified as a
predefined name. Allowed
values/formats:
morning hours
business hours
evening hours
all day
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
4
Analytics
GET: Summary of Count of SMA
Name
Required
Default
Type
Location
Description
period
String
query
The period of interest specified as one
of the predefined names: Allowed
values or formats:
today
yesterday
this week
last week
last 2 weeks
last month
this month
last 3 months
this year
last year
Content Type
application or json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
5
Analytics
GET: Details of SMA Count with Summary Type
GET: Details of SMA Count with Summary Type
Description
Retrieve the detailed summary count of SMA with the details of the Summary types: POSITIVES,
NEGATIVES, PHOTOS, NEUTRAL, TOTAL, REPOSTS.
HTTP Method
GET
Resource URI
/api/analytics/v1/sma/detailsummarycounts
Requires OAuth
N
Parameters
Table 3: Parameter Details
Name
Required
Default
Type
Location
Description
location
String
query
Location IDs for Social Media
Analytics. Allowed values or
formats: Location IDs of buildings
or campuses.
dailyHours
String
query
Hours of a day, specified by
predefined names. Allowed values
or formats:
morning hours
business hours
evening hours
all day
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
6
Analytics
GET: Details of SMA Count with Summary Type
Name
Required
Default
Type
Location
Description
period
String
query
The period of interest, specified one
of the predefined names. Allowed
values or formats:
today
yesterday
this week
last week
last 2 weeks
last month
this month
last 3 months
this year
last year
summaryType
String
query
The summary type of interest,
specified one of the predefined
names. Allowed values or formats:
positives
negatives
reposts
photos
neutral
total
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
7
Analytics
GET: All Summary Count of SMA with Hashtags
GET: All Summary Count of SMA with Hashtags
Description
Retrieve the entire summary counts of SMA with detailed Summary type: POSITIVES, NEGATIVES,
PHOTOS, NEUTRAL, TOTAL, REPOSTS.
HTTP Method
GET
Resource URI
/api/analytics/v1/sma/hashtags
Requires OAuth
N
Parameters
Table 4: Parameter Details
Name
Required
Default
Type
Location
Description
location
String
query
Location IDs for Social Media
Analytics. Allowed values or
formats: Location IDs of
buildings or campuses.
period
String
query
The period of interest, specified
one of the predefined names.
Allowed values or formats:
today
yesterday
this week
last week
last 2 weeks
last month
this month
last 3 months
this year
last year
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
8
Analytics
GET: All Summary Count of SMA with Hashtags
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
9
Analytics
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
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:
Table 5: Parameter Details
JSON Array Parameter
Description
granularity
The desired granularity.
Allowable Values/Formats
hourly
daily
weekly
monthly
yearly
tag
tag-name
heterarchy level. One can
limit to top n results (that is,
the n values with highest
count) by adding [n], or the
n bottom results by adding
[n]
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
10
Analytics
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
JSON Array Parameter
Description
period
The period of interest, specified as
either a date range, or one of the
predefined names.
Allowable Values/Formats
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
forever
timeRange
aggregate
The time window of interest on
each day. If the value "now" is
given, the granularity can only be
a tag name or heterarchy level .
Aggregate the dwell time by
granularity, for example, showing
the total dwell time for each day of
the week, instead of individual
dates.
HH:mm-HH:mm
now
none
sum
avg
areas
The list of areas of interest. If none A comma-separated list of area
are provided, all are considered.
IDs, or hierarchy levels.
durationCategories
Whether to break down the dwell
time between certain ranges of
dwell time .
includeStationary
Whether to include stationary
devices (default=false).
A comma-separated list of nn-mm
entries, where nn is the lower limit
(in minutes) of dwell time that is
considered and mm the upper limit.
true
false
connectionState
Whether to restrict connection to
either connected or detected
devices (default=all).
connected
detected
all
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
11
Analytics
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
JSON Array Parameter
Description
Allowable Values/Formats
percentageOf
If set this parameter, does not
report absolute numbers, only
relative percentage.
Heirarchy 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
default
minute
comma separated limit
label:limit value
descendantOf
subsetOf:comma separated
ids
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.
true
false
HTTP Method
POST
Resource URI
/api/analytics/v1/dwellBreakdown
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
12
Analytics
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
Requires OAuth
N
Parameters
Table 6: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
13
Analytics
POST: Paths for a Given Period and Areas
POST: Paths for a Given Period and Areas
Description
The only parameter (body) is a JSON array containing the parameters. The parameters are described below:
Table 7: Parameter Details
JSON array parameter
Description
period
The period of interest, either
specified as a date range, or one of
the predefined names
Allowable values/formats
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
forever
timeRange
The time window of interest on
each day. If "now" is given, the
granularity can only be a tag name
or heterarchy level
now
targetArea
The id of the target area for the
paths.
The ID of the target area for the
paths.
allAreas
The list of areas of interest.
A comma-separated list of area IDs
granularity
The desired geographical
granularity. This will replace the
areas listed in 'allAreas' withtheir
progeny on the appropriate level.
Heirarchy level
durationCategories
Filter devices to a duration
category time interval for target
and all areas
Time in the form nn-mm where nn
is the lower bound (in minutes) and
mm the upper bound.
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
14
HH:mm-HH:mm
Analytics
POST: Paths for a Given Period and Areas
HTTP Method
POST
Resource URI
/api/analytics/v1/path
Requires OAuth
N
Parameters
Table 8: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
15
Analytics
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas
POST: Retrieve a Breakdown of Manufacturers for a Given
Period and Areas
Description
The only parameter (body) is a JSON array containing the parameters. The parameters are described below
Table 9: Parameter Details
JSON array parameter
Description
granularity
The desired granularity. One can
limit to top n results (i.e. the n
values with highest count) by
adding "[n]", or the n bottom
results by adding "[-n"]. If
granularity null is specified, all
heterarchy types covered by the
areas are returned.
Allowable values/formats
hourly
daily
weekly
monthly
yearly
tag
tag-name
heterarchy level
null
period
The period of interest, either
specified as a date range, or one of
the predefined names
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
forever
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
16
Analytics
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas
JSON array parameter
Description
yAxis
Whether individual visits should
be reported on, or summed by
device (default is to return devices)
timeRange
aggregate
The time window of interest on
each day. If "now" is given, the
granularity can only be a tag name
or heterarchy level
Whether to aggregate the dwell
time by granularity; e.g. showing
a total for each day of the week,
instead of individual dates
Allowable values/formats
absoluteDevices
absoluteVisits
HH:mm-HH:mm
now
none
sum
avg
areas
The list of areas of interest. If none A comma-separated list of area ids,
are given, all are considered
or heterarchy levels
durationCategories
Whether to break down the dwell
time between certain ranges of
dwell time
includeStationary
Whether to include stationary
devices (default=false)
A comma-separate list of nn-mm
entries where nn is the lower bound
(in minutes) of dwell time
considered and mm the upper
bound.
none
sum
avg
connectionState
Whether to restrict to either
connected or detected devices
(default=all)
connected
detected
all
percentageOf
If set, does not report absolute
numbers, but relative percentage
heterarchy level
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
17
Analytics
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas
JSON array parameter
Description
Allowable values/formats
areaFilter
If set, 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.
descendantOf
subsetOf:comma separated
ids
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 of the elements
descendants in the result
true
false
HTTP Method
POST
Resource URI
/api/analytics/v1/manufacturers
Requires OAuth
N
Parameters
Table 10: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
18
Analytics
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
19
Analytics
GET: All summary KPI
GET: All summary KPI
Description
This API retrieves all summary of KPI.
HTTP Method
GET
Resource URI
/api/analytics/v1/summary
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
20
Analytics
GET: Specific set of Summary KPIs or a list of available ones
GET: Specific set of Summary KPIs or a list of available ones
Description
This API retrieves a specific set of summary KPIs or a list of available ones.
HTTP Method
GET
Resource URI
/api/analytics/v1/summary/:summaryItem
Requires OAuth
N
Parameters
Table 11: Parameter Details
Name
Required
Default
Type
Location
Description
summaryItem
String
pathReplace
A comma-separated list of
summary KPI to return, or
'availableMetrics' to see the
list of metrics available.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
21
Analytics
POST: Breakdown of Connected and Detected Devices for a Given Period and Areas
POST: Breakdown of Connected and Detected Devices for a
Given Period and Areas
Description
The only parameter (body) is a JSON array containing the parameters. The parameters are described below
Table 12: Parameter Details
JSON array parameter
Description
granularity
The desired granularity. One can
limit to top n results (i.e. the n
values with highest count) by
adding "[n]", or the n bottom
results by adding "[-n"]. If
granularity null is specified, all
heterarchy types covered by the
areas are returned.
Allowable values/formats
hourly
daily
weekly
monthly
yearly
tag
tag-name
heterarchy level
null
period
The period of interest, either
specified as a date range, or one of
the predefined names
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
forever
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
22
Analytics
POST: Breakdown of Connected and Detected Devices for a Given Period and Areas
JSON array parameter
Description
timeRange
The time window of interest on
each day. If "now" is given, the
granularity can only be a tag name
or heterarchy level
aggregate
Whether to aggregate the dwell
time by granularity; e.g. showing
a total for each day of the week,
instead of individual dates
Allowable values/formats
HH:mm-HH:mm
now
none
sum
avg
areas
The list of areas of interest. If none A comma-separated list of area ids,
are given, all are considered
or heterarchy levels
durationCategories
Whether to break down the dwell
time between certain ranges of
dwell time
includeStationary
Whether to include stationary
devices (default=false)
A comma-separate list of nn-mm
entries where nn is the lower bound
(in minutes) of dwell time
considered and mm the upper
bound.
true
false
percentageOf
If set, does not report absolute
numbers, but relative percentage
areaFilter
If set, 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
Heterarchy level
descendantOf
subsetOf:comma separated
ids
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.
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
23
Analytics
POST: Breakdown of Connected and Detected Devices for a Given Period and Areas
JSON array parameter
Description
Allowable values/formats
expandAll
Include all of the elements
descendants in the result
true
false
HTTP Method
POST
Resource URI
/api/analytics/v1/connectedDetected
Requires OAuth
N
Parameters
Table 13: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
24
Analytics
GET: Alerts for Device Count for a single Heterarchy Element and Time Frame
GET: Alerts for Device Count for a single Heterarchy Element
and Time Frame
Description
This API retrieves a list of notification events which matched device count rules for the given element and
time frame.
HTTP Method
GET
Resource URI
/api/analytics/v1/notifications/deviceCount/:elementId/:timeFrame
Requires OAuth
N
Parameters
Table 14: Parameter Details
Name
Required
Default
Type
Location
Description
elementId
String
pathReplace Numeric ID of the heterarchy
element.
timeFrame
String
pathReplace Number of minutes which
defines the timeframe
window.
For example, timeFrame=60
will retrieve notification
alerts for the last hour.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
25
Analytics
GET: Alerts for Device Count for a single Heterarchy Element
GET: Alerts for Device Count for a single Heterarchy Element
Description
Retrieves a list of notification events which matched device count rules for the given element.
HTTP Method
GET
Resource URI
/api/analytics/v1/notifications/deviceCount/:elementId
Requires OAuth
N
Parameters
Table 15: Parameter Details
Name
Required
Default
Type
Location
elementId
String
pathReplace Numeric ID of the
heterarchy element.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
26
Description
Analytics
GET: Retrieves Alerts for Device Count
GET: Retrieves Alerts for Device Count
Description
Retrieves a list of notification events which matched device count rules.
HTTP Method
GET
Resource URI
/api/analytics/v1/notifications/deviceCount
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
27
Analytics
POST: Queue Time for a Given Period and Areas
POST: Queue Time for a Given Period and Areas
Description
The only parameter (body) is a JSON array containing the parameters. The parameters are described below
Table 16: Parameter Details
JSON array parameter
Description
period
The period of interest, either
specified as a date range, or one of
the predefined names
Allowable values/formats
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
tag
heterarchy level
timeRange
The time window of interest on
each day. If "now" is given, the
granularity can only be a tag name
or heterarchy level
The area where the queue is
considered to have started. Only
zones are supported.
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
28
HH:mm-HH:mm
now
The ID of the area
Analytics
POST: Queue Time for a Given Period and Areas
JSON array parameter
Description
granularity
The desired granularity.
Allowable values/formats
fifteen min
hourly
daily
weekly
monthly
yearly
areaFilter
If set, 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
descendantOf
subsetOf:comma separated
ids
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.
Include all of the elements
descendants in the result
true
false
Whether to break down the dwell
time between certain ranges of
dwell time
A comma-separate list of nn-mm
entries where nn is the lower bound
(in minutes) of dwell time
considered and mm the upper
bound.
HTTP Method
POST
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
29
Analytics
POST: Queue Time for a Given Period and Areas
Resource URI
/api/analytics/v1/queue
Requires OAuth
N
Parameters
Table 17: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
30
Analytics
POST: Overview Data for Target Areas for Brochure View
POST: Overview Data for Target Areas for Brochure View
Description
The only parameter (body) is a JSON array containing the parameters. The parameters are described below
Table 18: Parameter Details
JSON array parameter
Description
type
The type of data requested
Allowable values/formats
deviceCount
deviceDwell
grossShopping
deviceCrossover
connectedDetected
dwellBreakdown
period
The period of interest, either
specified as a date range, or one of
the predefined names
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
forever
timeRange
The time window of interest on
each day
HH:mm-HH:mm
now
areas
The list of areas of interest. If none A comma-separated list of area ids,
are given, all are considered
or heterarchy levels
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
31
Analytics
POST: Overview Data for Target Areas for Brochure View
JSON array parameter
Description
Allowable values/formats
durationCategories
Whether to break down the count
between certain ranges of dwell
time
nn-mm, where nn is the lower
bound (in minutes) of dwell time
considered and mm the upper
bound.
includeStationary
Whether to include stationary
devices (default=false)
true
false
entirePeriod
connectionState
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.
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
dwellLimits
The dwell time limits that specifies
how dwellers should be grouped
together.
Pass -1 to catch all.Example:
Light:100,Medium:200,Heavy:-1.
HTTP Method
POST
Resource URI
/api/analytics/v1/overview
Requires OAuth
N
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
32
true
false
connected
detected
all
Heterarchy level
default
comma separated limit
label:limit value
Analytics
POST: Overview Data for Target Areas for Brochure View
Parameters
Table 19: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
33
Analytics
POST: Dwell Time for a Given Period and Areas
POST: Dwell Time for a Given Period and Areas
Description
The only parameter is a JSON array containing the parameters. The parameters are described below
Table 20: Parameter Details
JSON array parameter
Description
granularity
The desired granularity. One can
limit to top n results (i.e. the n
values with highest count) by
adding "[n]", or the n bottom
results by adding "[-n"]. If
granularity null is specified, all
heterarchy types covered by the
areas are returned.
Allowable values/formats
hourly
daily
weekly
monthly
yearly
tag
tag-name
heterarchy level
null
period
The period of interest, either
specified as a date range, or one of
the predefined names
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
forever
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
34
Analytics
POST: Dwell Time for a Given Period and Areas
JSON array parameter
Description
timeRange
The time window of interest on
each day
Allowable values/formats
HH:mm-HH:mm
now
aggregate
Whether to aggregate the dwell
time by granularity; e.g. showing
a total for each day of the week,
instead of individual dates
none
sum
avg
areas
The list of areas of interest. If none A comma-separated list of area ids,
are given, all are considered
or heterarchy levels
durationCategories
Whether to break down the dwell
time between certain ranges of
dwell time
includeStationary
Whether to include stationary
devices
A comma-separate list of nn-mm
entries where nn is the lower bound
(in minutes) of dwell time
considered and mm the upper
bound.
true
false
connectionState
Whether to restrict to either
connected or detected devices
(default=all)
connected
detected
all
percentageOf
If set, does not report absolute
numbers, but relative percentage
Heterarchy level
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
35
Analytics
POST: Dwell Time for a Given Period and Areas
JSON array parameter
Description
Allowable values/formats
areaFilter
If set, 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
descendantOf
subsetOf:comma separated
ids
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 of the elements
descendants in the result
true
false
HTTP Method
POST
Resource URI
/api/analytics/v1/deviceDwell
Requires OAuth
N
Parameters
Table 21: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
36
Analytics
POST: Dwell Time for a Given Period and Areas
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
37
Analytics
POST: Device Count for a Given Period and Areas
POST: Device Count for a Given Period and Areas
Description
The only parameter (body) is a JSON array containing the parameters. The parameters are described below
Table 22: Parameter Details
JSON array parameter
Description
granularity
The desired granularity. One can
limit to top n results (i.e. the n
values with highest count) by
adding "[n]", or the n bottom
results by adding "[-n"]. If
granularity null is specified, all
heterarchy types covered by the
areas are returned.
Allowable values/formats
hourly
daily
weekly
monthly
yearly
tag
tag-name
heterarchy level
null
period
The period of interest, either
specified as a date range, or one of
the predefined names
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
forever
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
38
Analytics
POST: Device Count for a Given Period and Areas
JSON array parameter
Description
timeRange
The time window of interest on
each day. If "now" is given, the
granularity can only be a tag name
or heterarchy level
aggregate
Whether to aggregate the dwell
time by granularity; e.g. showing
a total for each day of the week,
instead of individual dates
Allowable values/formats
HH:mm-HH:mm
now
none
sum
avg
areas
The list of areas of interest. If none A comma-separated list of area ids,
are given, all are considered
or heterarchy levels
durationCategories
Whether to break down the dwell
time between certain ranges of
dwell time
includeStationary
Whether to include stationary
devices (default=false)
A comma-separate list of nn-mm
entries where nn is the lower bound
(in minutes) of dwell time
considered and mm the upper
bound.
true
false
connectionState
Whether to restrict to either
connected or detected devices
(default=all)
connected
detected
all
percentageOf
If set, does not report absolute
numbers, but relative percentage
Heterarchy level
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
39
Analytics
POST: Device Count for a Given Period and Areas
JSON array parameter
Description
Allowable values/formats
areaFilter
If set, 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
descendantOf
subsetOf:comma separated
ids
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 of the elements
descendants in the result
true
false
HTTP Method
POST
Resource URI
/api/analytics/v1/deviceCount
Requires OAuth
N
Parameters
Table 23: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
40
Analytics
POST: Device Count for a Given Period and Areas
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
41
Analytics
POST: Device Count for a Given Period and Areas
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
42
Configuration
GET: Get Supported Northbound Notifications, page 46
GET: Current CMX Image Version, page 47
GET: Count of Active Alerts, page 48
GET: All Alerts, page 49
POST: Add Role to User, page 50
DELETE: Role from User, page 51
GET: All Users in the System, page 52
POST: Create a User, page 53
POST: Modify User, page 54
GET: User by Username, page 55
DELETE: User by Username, page 56
GET: All Roles, page 57
GET: All Campuses, page 58
GET: Campus by Name, page 59
PUT: Add Campus, page 60
GET: Count of All Map Elements, page 61
GET: List of all Building Names., page 62
GET: List of all Building Names, page 63
GET: List of all Floor Names, page 64
GET: List of all Floor Names, page 65
GET: All Maps, page 66
GET: Campus by Name, page 67
GET: Building by Name Inside Specific Campus, page 68
GET: Floor Inside Specific Building and Specific Campus, page 69
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
43
Configuration
GET: Floor Image, page 70
GET: Image by Name, page 71
GET: All Sites, page 72
GET: Site Details by ID or Name, page 73
GET: System Settings, page 74
PUT: System Settings, page 75
GET: All Notification Subscriptions, page 76
GET: Notifications by Name, page 77
GET: Notification Subscription Availability, page 78
PUT: Add Notification Subscription, page 79
PUT: List of Notification Subscriptions, page 82
DELETE: Notification Subscription, page 83
GET: System Alert Subscription, page 84
GET: Notifications by Name, page 85
PUT: System Alert Subscription, page 86
PUT: List of System Alert Subscriptions, page 89
DELETE: Notification Alert Subscription, page 90
POST: Change Status of Notification by Name, page 91
GET: Unique Alerts by Time Interval, page 92
GET: Alert by Time Interval, page 93
GET: Alerts by Time Interval and Hashkey, page 94
GET: Total Alerts Created for a Given Alert Key, page 95
GET: All APs, page 96
GET: Access Point by MAC Address, page 97
GET: Settings for a Given User, page 98
PUT: Setting for a Given User, page 99
GET: All Cisco WLC Controllers, page 100
GET: Get Cisco WLC Controllers by IP address, page 101
PUT: Controller, page 102
POST: Devices to the opt-out List, page 104
DELETE: List of Devices from Opt-out, page 105
DELETE: All opt-out Devices, page 106
GET: List of Opt-out Devices Within a Date Range, page 107
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
44
Configuration
GET: Count of opt-out Devices , page 108
DELETE: Opt-out Devices Within a Date Range, page 109
GET: List of Children Superzone IDs of a Hiterarchy Element, page 110
GET: Children Superzone IDs of Hiterarchy Element, page 112
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
45
Configuration
GET: Get Supported Northbound Notifications
GET: Get Supported Northbound Notifications
Description
This API returns all supported notrhbound notification types and applicable attributes for the notification
rules.
HTTP Method
GET
Resource URI
/api/configuration/v1/attributes
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
46
Configuration
GET: Current CMX Image Version
GET: Current CMX Image Version
Description
This API returns the current version of the CMX Image.
HTTP Method
GET
Resource URI
/api/config/v1/version/image
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
47
Configuration
GET: Count of Active Alerts
GET: Count of Active Alerts
Description
This API returns count of active alerts.
HTTP Method
GET
Resource URI
/api/config/v1/alerts/count
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
48
Configuration
GET: All Alerts
GET: All Alerts
Description
This API returns all active alerts.
HTTP Method
GET
Resource URI
/api/config/v1/alerts
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
49
Configuration
POST: Add Role to User
POST: Add Role to User
Description
This API adds a role to a user.
HTTP Method
POST
Resource URI
/api/config/v1/aaa/users/:username/role/:rolename
Requires OAuth
N
Parameters
Table 24: Parameter Details
Name
Required
Default
Type
Location
Description
username
String
pathReplace
Username of the user.
rolename
String
pathReplace
Role name to be added to the
user.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
50
Configuration
DELETE: Role from User
DELETE: Role from User
Description
Remove role from a user.
HTTP Method
DELETE
Resource URI
/api/config/v1/aaa/users/:username/role/:rolename
Requires OAuth
N
Parameters
Table 25: Parameter Details
Name
Required
Default
Type
Location
Description
username
String
pathReplace
Username of user.
rolename
String
pathReplace
Role name that needs to
be deleted from this
user.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
51
Configuration
GET: All Users in the System
GET: All Users in the System
Description
This API gets the details of all users in the system.
HTTP Method
GET
Resource URI
/api/config/v1/aaa/users
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
52
Configuration
POST: Create a User
POST: Create a User
Description
This API enables you to create a user.
HTTP Method
POST
Resource URI
/api/config/v1/aaa/users
Requires OAuth
N
Parameters
Table 26: Parameter Details
Name
Required
Default
Type
Location
Description
___username
string
body
Username of the user.
password
string
body
Password of the user.
firstname
string
body
First name of the user.
lastname
string
body
Last name of the user.
roles
text
body
Roles for this user.
developerkey
string
body
CMX API Developer
Key.
lastlogin
text
body
User's last login.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
53
Configuration
POST: Modify User
POST: Modify User
Description
This API modifies the attributes of a user.
HTTP Method
POST
Resource URI
/api/config/v1/aaa/users/:username
Requires OAuth
N
Parameters
Table 27: Parameter Details
Name
Required
Default
Type
Location
username
String
pathReplace Username name of the
user
___username
string
body
Username of the user.
password
string
body
Password of the user.
firstname
string
body
First name of the user.
lastname
string
body
Last name of the user.
roles
text
body
Roles assigned to this
user.
developerkey
string
body
CMX API Developer
Key.
lastlogin
text
body
User's Last Login.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
54
Description
Configuration
GET: User by Username
GET: User by Username
Description
This API retrives user by username.
HTTP Method
GET
Resource URI
/api/config/v1/aaa/users/:username
Requires OAuth
N
Parameters
Table 28: Parameter Details
Name
Required
Default
Type
Location
Description
username
String
pathReplace
Username
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
55
Configuration
DELETE: User by Username
DELETE: User by Username
Description
This API deletes a user.
HTTP Method
DELETE
Resource URI
/api/config/v1/aaa/users/:username
Requires OAuth
N
Parameters
Table 29: Parameter Details
Name
Required
Default
Type
Location
Description
username
String
pathReplace
Username.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
56
Configuration
GET: All Roles
GET: All Roles
Description
This API gets all roles.
HTTP Method
GET
Resource URI
/api/config/v1/aaa/roles
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
57
Configuration
GET: All Campuses
GET: All Campuses
Description
This API gets information about all campuses.
HTTP Method
GET
Resource URI
/api/config/v1/campuses
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
58
Configuration
GET: Campus by Name
GET: Campus by Name
Description
This API returns a campus by name.
HTTP Method
GET
Resource URI
/api/config/v1/campuses/:name
Requires OAuth
N
Parameters
Table 30: Parameter Details
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Campus Name .
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
59
Configuration
PUT: Add Campus
PUT: Add Campus
Description
This API enables you to add a campus.
HTTP Method
PUT
Resource URI
/api/config/v1/campuses
Requires OAuth
N
Parameters
Table 31: Parameter Details
Name
Required
Default
Type
Location
Description
objectVersion
number
body
objectVersion
name
string
body
Name of the campus.
This value should be
unique.
dimension
text
body
Dimension
image
text
body
image
buildingList
text
body
List of buildings inside
the campus.
aesUid
number
body
aesUid
aesUidString
string
body
aesUidString
members
text
body
members
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
60
Configuration
GET: Count of All Map Elements
GET: Count of All Map Elements
Description
This API provides count of campuses, buildings, and floors.
HTTP Method
GET
Resource URI
/api/config/v1/maps/count
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
61
Configuration
GET: List of all Building Names.
GET: List of all Building Names.
Description
This API provides a list of all Buildings.
HTTP Method
GET
Resource URI
/api/config/v1/maps/building/list/:name
Requires OAuth
N
Parameters
Table 32: Parameter Details
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Campus Name
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
62
Configuration
GET: List of all Building Names
GET: List of all Building Names
Description
This API provides a list of all buildings.
HTTP Method
GET
Resource URI
/api/config/v1/maps/building/list
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
63
Configuration
GET: List of all Floor Names
GET: List of all Floor Names
Description
This API provides a list of all Floors in the system.
HTTP Method
GET
Resource URI
/api/config/v1/maps/floor/list/:name
Requires OAuth
N
Parameters
Table 33: Parameter Details
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Building Name
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
64
Configuration
GET: List of all Floor Names
GET: List of all Floor Names
Description
This API provides a list of all Floors in the system.
HTTP Method
GET
Resource URI
/api/config/v1/maps/floor/list
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
65
Configuration
GET: All Maps
GET: All Maps
Description
This API returns all maps.
HTTP Method
GET
Resource URI
/api/config/v1/maps
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
66
Configuration
GET: Campus by Name
GET: Campus by Name
Description
This API returns a campus by name.
HTTP Method
GET
Resource URI
/api/config/v1/maps/info/:campusName
Requires OAuth
N
Parameters
Table 34: Parameter Details
Name
Required
Default
Type
Location
Description
campusName
String
pathReplace
Campus Name
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
67
Configuration
GET: Building by Name Inside Specific Campus
GET: Building by Name Inside Specific Campus
Description
This API returns a building by name.
HTTP Method
GET
Resource URI
/api/config/v1/maps/info/:campusName/:buildingName
Requires OAuth
N
Parameters
Table 35: Parameter Details
Name
Required
Default
Type
Location
Description
campusName
String
pathReplace
Campus Name.
buildingName
String
pathReplace
Building Name.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
68
Configuration
GET: Floor Inside Specific Building and Specific Campus
GET: Floor Inside Specific Building and Specific Campus
Description
This API returns a floor by name based on a specific building and campus.
HTTP Method
GET
Resource URI
/api/config/v1/maps/info/:campusName/:buildingName/:floorName
Requires OAuth
N
Parameters
Table 36: Parameter Details
Name
Required
Default
Type
Location
Description
campusName
String
pathReplace
Campus Name.
buildingName
String
pathReplace
Building Name.
floorName
String
pathReplace
Floor Name.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
69
Configuration
GET: Floor Image
GET: Floor Image
Description
This API returns an image for a given combination of Campus, Building, and Floor name.
HTTP Method
GET
Resource URI
/api/config/v1/maps/image/:campusName/:buildingName/:floorName
Requires OAuth
N
Parameters
Table 37: Parameter Details
Name
Required
Default
Type
Location
Description
campusName
String
pathReplace
Campus Name.
buildingName
String
pathReplace
Building Name.
floorName
String
pathReplace
Floor Name.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
70
Configuration
GET: Image by Name
GET: Image by Name
Description
This API returns an image by image name.
HTTP Method
GET
Resource URI
/api/config/v1/maps/imagesource/:imageName
Requires OAuth
N
Parameters
Table 38: Parameter Details
Name
Required
Default
Type
Location
Description
imageName
String
pathReplace
Image Name.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
71
Configuration
GET: All Sites
GET: All Sites
Description
This API returns all the presence sites.
HTTP Method
GET
Resource URI
/api/config/v1/sites
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
72
Configuration
GET: Site Details by ID or Name
GET: Site Details by ID or Name
Description
This API returns the presence site for the specified ID or Name.
HTTP Method
GET
Resource URI
/api/config/v1/sites/:id
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
73
Configuration
GET: System Settings
GET: System Settings
Description
This API retrives system settings.
HTTP Method
GET
Resource URI
/api/config/v1/system/preferences/:component/:key
Requires OAuth
N
Parameters
Table 39: Parameter Details
Name
Required
Default
Type
Location
Description
component
String
pathReplace
The component.
key
String
pathReplace
The key to retrieve. If
not set, retrieves all keys
for the given
component.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
74
Configuration
PUT: System Settings
PUT: System Settings
Description
This API enable you to store system settings. This operation can only be performed by users in the 'Admin'
group.
HTTP Method
PUT
Resource URI
/api/config/v1/system/preferences/:component/:key
Requires OAuth
N
Parameters
Table 40: Parameter Details
Name
Required
Default
Type
Location
Description
component
String
pathReplace
The component.
key
String
pathReplace
The key.
String
string
body
Value.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
75
Configuration
GET: All Notification Subscriptions
GET: All Notification Subscriptions
Description
This API returns all notification subscriptions.
HTTP Method
GET
Resource URI
/api/config/v1/notifications
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
76
Configuration
GET: Notifications by Name
GET: Notifications by Name
Description
This API returns a notification subscription by name.
HTTP Method
GET
Resource URI
/api/config/v1/notifications/:name
Requires OAuth
N
Parameters
Table 41: Parameter Details
Name
Required
Default
Type
Location
Description
name
String
pathReplace Notification Name.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
77
Configuration
GET: Notification Subscription Availability
GET: Notification Subscription Availability
Description
This API checks if a notification subscription exiets. It returns FOUND(302) if exists, 404 is not found.
HTTP Method
GET
Resource URI
/api/config/v1/notifications/exists/:name
Requires OAuth
N
Parameters
Table 42: Parameter Details
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Notification Name.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
78
Configuration
PUT: Add Notification Subscription
PUT: Add Notification Subscription
Description
This API allows you to add a notification subscription.
HTTP Method
PUT
Resource URI
/api/config/v1/notification
Requires OAuth
N
Parameters
Table 43: Parameter Details
Name
Required
Default
Type
Location
Description
userId
string
body
User ID.
rules
text
body
List of rules.
subscribers
text
body
Subscribers
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
79
Configuration
PUT: Add Notification Subscription
Name
Required
Default
Type
Location
notificationType
enumerated body
Description
Choose one of the following
notification types:
Any
Absence
AreaChange
Association
BatteryLife
Chokepoint
Containment
Emergency
Movement
Presence
LocationUpdate
Zone
Location
ServiceStatus
NetworkDesignChanged
CpuUsage
MemoryUsage
DiskUsage
BeaconMovement
BeaconAbsence
Update
InOut
PasserbyDetected
PasserbyBecameVisitor
VisitorWentAway
SiteEntryChanged
enabled
enumerated body
enabled
true
false
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
80
Configuration
PUT: Add Notification Subscription
Name
Required
enableMacScrambling N
Default
Type
Location
enumerated body
Description
enableMacScrambling
true
false
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
81
Configuration
PUT: List of Notification Subscriptions
PUT: List of Notification Subscriptions
Description
This API allows you to add a list of notification subscriptions.
HTTP Method
PUT
Resource URI
/api/config/v1/notifications
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
82
Configuration
DELETE: Notification Subscription
DELETE: Notification Subscription
Description
This API allows to delete a notification subscription.
HTTP Method
DELETE
Resource URI
/api/config/v1/notifications/:name
Requires OAuth
N
Parameters
Table 44: Parameter Details
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Notification
Name.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
83
Configuration
GET: System Alert Subscription
GET: System Alert Subscription
Description
This API returns a system alert notification subscription by name.
HTTP Method
GET
Resource URI
/api/config/v1/notifications/alerts
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
84
Configuration
GET: Notifications by Name
GET: Notifications by Name
Description
This API returns a system alert notification subscription by name.
HTTP Method
GET
Resource URI
/api/config/v1/notifications/alerts/:name
Requires OAuth
N
Parameters
Table 45: Parameter Details
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Notification
Name.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
85
Configuration
PUT: System Alert Subscription
PUT: System Alert Subscription
Description
This API allows to add system alert subscription.
HTTP Method
PUT
Resource URI
/api/config/v1/notifications/alert
Requires OAuth
N
Parameters
Table 46: Parameter Details
Name
Required
Default
Type
Location
Description
severity
enumerated
body
Choose one of the following
severity levels:
Critical
Major
Minor
Warning
Info
Cleared
userId
string
body
User ID.
rules
text
body
List of rules.
subscribers
text
body
Subscribers
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
86
Configuration
PUT: System Alert Subscription
Name
Required
notificationType Y
Default
Type
Location
Description
enumerated
body
Choose one of the following
notification types:
Any
Absence
AreaChange
Association
BatteryLife
Chokepoint
Containment
Emergency
Movement
Presence
LocationUpdate
Zone
Location
ServiceStatus
NetworkDesignChanged
CpuUsage
MemoryUsage
DiskUsage
BeaconMovement
BeaconAbsence
Update
InOut
PasserbyDetected
PasserbyBecameVisitor
VisitorWentAway
SiteEntryChanged
enabled
enumerated
body
enabled
true
false
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
87
Configuration
PUT: System Alert Subscription
Name
Required
enableMacScrambling N
Default
Type
Location
Description
enumerated
body
enableMacScrambling
true
false
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
88
Configuration
PUT: List of System Alert Subscriptions
PUT: List of System Alert Subscriptions
Description
This API allows to add a list of system alert subscriptions.
HTTP Method
PUT
Resource URI
/api/config/v1/notifications/alerts
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
89
Configuration
DELETE: Notification Alert Subscription
DELETE: Notification Alert Subscription
Description
This API allows you to delete a system alert notification subscription.
HTTP Method
DELETE
Resource URI
/api/config/v1/notifications/alerts/:name
Requires OAuth
N
Parameters
Table 47: Parameter Details
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Notification
Name.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
90
Configuration
POST: Change Status of Notification by Name
POST: Change Status of Notification by Name
Description
This API enable/disable a notification subscription by name.
HTTP Method
POST
Resource URI
/api/config/v1/notifications/:name/:action
Requires OAuth
N
Parameters
Table 48: Parameter Details
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Notification
Name.
action
String
pathReplace
Enable/Disable
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
91
Configuration
GET: Unique Alerts by Time Interval
GET: Unique Alerts by Time Interval
Description
This API returns a list of unique alerts by time interval.
HTTP Method
GET
Resource URI
/api/config/v1/history/alerts/unique
Requires OAuth
N
Parameters
Table 49: Parameter Details
Name
Required
Default
Type
Location
Description
startTime
Number
query
Specifies the start time in
milliseconds.
endTime
Number
query
Specifies the end time in
milliseconds.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
92
Configuration
GET: Alert by Time Interval
GET: Alert by Time Interval
Description
This API returns a list of alerts by time interval.
HTTP Method
GET
Resource URI
/api/config/v1/history/alerts
Requires OAuth
N
Parameters
Table 50: Parameter Details
Name
Required
Default
Type
Location
Description
startTime
Number
query
Specifies the start time
in milliseconds.
endTime
Number
query
Specifies the end time
in milliseconds.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
93
Configuration
GET: Alerts by Time Interval and Hashkey
GET: Alerts by Time Interval and Hashkey
Description
This API returns a list of alerts by time interval and hashkey.
HTTP Method
GET
Resource URI
/api/config/v1/history/alerts/:key
Requires OAuth
N
Parameters
Table 51: Parameter Details
Name
Required
Default
Type
Location
Description
key
String
pathReplace
Alert Hashkey which could be
obtained by calling /config/v1/alerts.
startTime
Number
query
Specifies the start time in
milliseconds.
endTime
Number
query
Specifies the end time in
milliseconds.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
94
Configuration
GET: Total Alerts Created for a Given Alert Key
GET: Total Alerts Created for a Given Alert Key
Description
This API returns number of alerts for a given alert key.
HTTP Method
GET
Resource URI
/api/config/v1/history/alert/count/:key
Requires OAuth
N
Parameters
Table 52: Parameter Details
Name
Required
Default
Type
Location
Description
key
String
pathReplace
Alert Hashkey which could be obtained
by calling /config/v1/alerts.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
95
Configuration
GET: All APs
GET: All APs
Description
This API returns all APs.
HTTP Method
GET
Resource URI
/api/config/v1/aps
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
96
Configuration
GET: Access Point by MAC Address
GET: Access Point by MAC Address
Description
This API returns access point by given ap MAC address.
HTTP Method
GET
Resource URI
/api/config/v1/aps/:mac
Requires OAuth
N
Parameters
Table 53: Parameter Details
Name
Required
Default
Type
Location
Description
mac
String
pathReplace
Access point
MAC address.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
97
Configuration
GET: Settings for a Given User
GET: Settings for a Given User
Description
This API retrieves settings for a given user.
HTTP Method
GET
Resource URI
/api/config/v1/user/preferences/:userid/:component/:key
Requires OAuth
N
Parameters
Table 54: Parameter Details
Name
Required
Default
Type
Location
userid
String
pathReplace The user ID.
component
String
pathReplace The component.
key
String
pathReplace The key to retrieve. If not
set, retrieves all keys for
the given component.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
98
Description
Configuration
PUT: Setting for a Given User
PUT: Setting for a Given User
Description
This API stores the settings of a given user.
HTTP Method
PUT
Resource URI
/api/config/v1/user/preferences/:userid/:component/:key
Requires OAuth
N
Parameters
Table 55: Parameter Details
Name
Required
Default
Type
Location
Description
userid
String
pathReplace
The user ID.
component
String
pathReplace
The component.
key
String
pathReplace
The key.
json
String
query
Whether the data passed is
JSON - if set, this will validate
the data and reject malformed
JSON Allowed values/formats:
true or false.
String
string
body
Value
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
99
Configuration
GET: All Cisco WLC Controllers
GET: All Cisco WLC Controllers
Description
This API provides a list of all Cisco WLC Controllers.
HTTP Method
GET
Resource URI
/api/config/v1/controllers
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
100
Configuration
GET: Get Cisco WLC Controllers by IP address
GET: Get Cisco WLC Controllers by IP address
Description
This API returns a controller given an IP address.
HTTP Method
GET
Resource URI
/api/config/v1/controllers/:ipAddress
Requires OAuth
N
Parameters
Table 56: Parameter Details
Name
Required
Default
Type
Location
Description
ipAddress
String
pathReplace
IP Address.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
101
Configuration
PUT: Controller
PUT: Controller
Description
This API allows you to add a controller.
HTTP Method
PUT
Resource URI
/api/config/v1/controllers
Requires OAuth
N
Parameters
Table 57: Parameter Details
Name
Required
Default
Type
Location
Description
name
string
body
Name of the Wireless LAN
controller.
ipAddress
string
body
IP address of the Wireless LAN
controller.
readOnlyComm
string
body
SNMP Read Community.
writeComm
string
body
SNMP Write Community.
snmpVersion
number
body
SNMP Version.
version
string
body
Software version of the WLC
Controller.
userName
string
body
User name for the telnet
connection.
authType
number
body
SNMP v3 Auth Type.
authPassword
string
body
Authentication Password.
privType
number
body
Privacy Type.
privPassword
string
body
Password.
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
102
Configuration
PUT: Controller
Name
Required
Default
Type
Location
Description
macAddress
string
body
MAC Address.
sysUpTime
number
body
System Up time.
unauthenticatedConnection N
enumerated body
Authentication to connect to the
WLC Controller.
true
false
applicableServices Y
array
body
Services to subscribe to the
controller.
aesUId
number
body
Cisco Prime Infrastructure
generated unique ID. If not
generated by Cisco Prime
Infrastructure, please use a
unique value.
objectVersion
number
body
Object version.
tagNotificationInterval N
number
body
Tag notification interval.
wlanConfigList
text
body
WLC Controller Configuration
list.
deviceVersion
string
body
Version of the device.
type
enumerated body
type
WLC
NGWC
enablePassword
string
peerMode
enumerated body
body
enablePassword
peerMode
true
false
members
text
body
Members.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
103
Configuration
POST: Devices to the opt-out List
POST: Devices to the opt-out List
Description
This API adds devices to opt-out service.
HTTP Method
POST
Resource URI
/api/configuration/v1/optout/devices
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
104
Configuration
DELETE: List of Devices from Opt-out
DELETE: List of Devices from Opt-out
Description
This API deletes a list of devices from opt-out service.
HTTP Method
DELETE
Resource URI
/api/configuration/v1/optout/devices
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
105
Configuration
DELETE: All opt-out Devices
DELETE: All opt-out Devices
Description
This API allows to delete ALL opt-out devices from opt-out service.
HTTP Method
DELETE
Resource URI
/api/configuration/v1/optout/devices/all
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
106
Configuration
GET: List of Opt-out Devices Within a Date Range
GET: List of Opt-out Devices Within a Date Range
Description
This API return a full list of opt-out devices within a date range.
HTTP Method
GET
Resource URI
/api/configuration/v1/optout/devices
Requires OAuth
N
Parameters
Table 58: Parameter Details
Name
Required
Default
Type
Location
Description
validFrom
String
query
Start date of range Allowed values/formats:
yyyy-mm-dd hh:mm:ss
validTo
String
query
End date of range Allowed values/formats:
yyyy-mm-dd hh:mm:ss
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
107
Configuration
GET: Count of opt-out Devices
GET: Count of opt-out Devices
Description
This API return a count of opt-out devices.
HTTP Method
GET
Resource URI
/api/configuration/v1/optout/count
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
108
Configuration
DELETE: Opt-out Devices Within a Date Range
DELETE: Opt-out Devices Within a Date Range
Description
This API deletes opt-out devices.
HTTP Method
DELETE
Resource URI
/api/configuration/v1/optout/devices/date
Requires OAuth
N
Parameters
Table 59: Parameter Details
Name
Required
Default
Type
Location
Description
validFrom
String
query
Start date of range Allowed
values/formats: yyyy-mm-dd
hh:mm:ss.
validTo
String
query
End date of range Allowed
values/formats: yyyy-mm-dd
hh:mm:ss.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
109
Configuration
GET: List of Children Superzone IDs of a Hiterarchy Element
GET: List of Children Superzone IDs of a Hiterarchy Element
Description
The call retrieves children superzone IDs of a heterarchy element and, under them, the AES IDs of the nested
children floors. The element is identified by the path of the API call (either the full path or the id of the elementsee Add/Update zones or tags for details on obtaining the element id).
HTTP Method
GET
Resource URI
/api/config/v1/heterarchy/:pathSegments/childrenfloors
Requires OAuth
N
Parameters
Table 60: Parameter Details
Name
Required
Default
Type
Location
Description
pathSegments
String
pathReplace
Full path to the
element or
element id.
validDate
String
query
Show elements
valid at given
date
(yyyy-mm-dd
HH:mm:ss)
Allowed
values/formats:
yyyy-mm-dd
HH:mm:ss.
level
String
query
Level name
(SUPERZONE,
FLOOR, AP,
POI, or ZONE)
Allowed
values/formats:
SUPERZONE
FLOOR AP
ZONE POI.
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
110
Configuration
GET: List of Children Superzone IDs of a Hiterarchy Element
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
111
Configuration
GET: Children Superzone IDs of Hiterarchy Element
GET: Children Superzone IDs of Hiterarchy Element
Description
The call retrieves children superzone IDs of an heterarchy element and, under them, the counts of all the
nested children elements. The element is identified by the path of the API call (either the full path or the ID
of the element- see Add/Update zones or tags for details on obtaining the element id). Specifying a level
retrieves only children of that level.
HTTP Method
GET
Resource URI
/api/config/v1/heterarchy/:pathSegments/childrencounts
Requires OAuth
N
Parameters
Table 61: Parameter Details
Name
Required Default
Type
Location
Description
pathSegments
String
pathReplace
Full path to the element or element ID.
validDate
String
query
Show elements valid from given date
(yyyy-mm-dd HH:mm:ss) Allowed
values/formats: yyyy-mm-dd HH:mm:ss.
level
String
query
Level name (SUPERZONE, FLOOR, AP,
POI, or ZONE) Allowed values/formats:
SUPERZONE FLOOR AP ZONE POI.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
112
Connect
GET: Query User Sessions, page 114
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
113
Connect
GET: Query User Sessions
GET: Query User Sessions
Description
Query user session data based on the filter criteria. The results are sorted by last login time in descending
order. The search can be performed on MAC addresses, last session time, status, and any or all fields. The
query is paged using index and count parameters with maximum size in 1000. The returned JSON object
includes the number of records returned and next index to query if more. You can also download the queried
result in CSV file with URL /api/connect/v1/clients/export. The export query does not have maximum size
limit.
HTTP Method
GET
Resource URI
/api/connect/v1/clients
Requires OAuth
N
Parameters
Table 62: Parameter Details
Name
Required
Default
Type
Location
Description
start
String
query
Session start time based on last login
time in UTC format.
end
String
query
Session end time based on last login
time in UTC format.
index
String
query
Starting index of the query based on
0.
count
String
query
Number of records to query with the
limit of 1000 at maximum.
status
String
query
Status of the users. Allowed:
all,active.
authtype
String
query
Authentication type used by the
user. Allowed
values/formats:registration, SMS,
social.
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
114
Connect
GET: Query User Sessions
Name
Required
Default
Type
Location
Description
mac
String
query
MAC address in
00:11:22:33:44:55:66 format. If
MAC address is used, all other
parameters will be ignored.
device
String
query
Type of user's device.
os
String
query
Operating system of user's device.
language
String
query
Language served to the user. It can
search by full language name or
two-letter language code.
all
String
query
The search applies to all fields.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
115
Connect
GET: Query User Sessions
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
116
Location
GET: Active Tags Count, page 118
GET: All Tags, page 119
GET: Tag by MAC Address, page 120
GET: Supported Northbound Notifications, page 121
GET: Count of all the Beacons, page 122
PUT: Place a Beacon at Detected Location on Map, page 123
PUT: Updates Name of a Given Beacon, page 124
GET: List of Beacons Matching Filter Criteria, page 125
POST: Add Beacon with Minimum Fields, page 126
GET: Beacons with Minimum Information for a Floor ID, page 127
GET: List of Beacons, page 128
GET: Beacon by MAC Address, page 129
DELETE: Delete Beacon by MAC Address, page 130
PUT: Update Beacon, page 131
GET: List of Beacons Present on a Floor, page 133
POST: Add Beacon to the Store, page 134
GET: Active Clients Count, page 136
GET: All clients, page 137
GET: Collection of Active Clients MAC Address, page 138
GET: Compact History of Client by Date and Username, page 139
GET: Unique MAC Address Seen on a Given Day on a Floor or Zone, page 140
GET: Compact History of Client By Date and IPv4 Address, page 142
GET: This API returns history for all clients, page 143
GET: History of Client by MAC Address, page 144
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
117
Location
GET: Active Tags Count
GET: Active Tags Count
Description
This API returns active tags count.
HTTP Method
GET
Resource URI
/api/location/v1/tags/count
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
118
Location
GET: All Tags
GET: All Tags
Description
This API returns all tags.
HTTP Method
GET
Resource URI
/api/location/v1/tags
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
119
Location
GET: Tag by MAC Address
GET: Tag by MAC Address
Description
This API returns a tag by its MAC address.
HTTP Method
GET
Resource URI
/api/location/v1/tags/:macaddress
Requires OAuth
N
Parameters
Table 63: Parameter Details
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
Tag MAC
address.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
120
Location
GET: Supported Northbound Notifications
GET: Supported Northbound Notifications
Description
This API returns all supported notification types and applicable attributes for the notification rules.
HTTP Method
GET
Resource URI
/api/location/v1/attributes
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
121
Location
GET: Count of all the Beacons
GET: Count of all the Beacons
Description
This API returns count of all beacons.
HTTP Method
GET
Resource URI
/api/location/v1/beacon/count
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
122
Location
PUT: Place a Beacon at Detected Location on Map
PUT: Place a Beacon at Detected Location on Map
Description
This API places a beacon at detected location on the map.
HTTP Method
PUT
Resource URI
/api/location/v1/beacon/replace/:macaddress
Requires OAuth
N
Parameters
Table 64: Parameter Details
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
Mac address of
beacon.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
123
Location
PUT: Updates Name of a Given Beacon
PUT: Updates Name of a Given Beacon
Description
This API updates the name of a given Beacon.
HTTP Method
PUT
Resource URI
/api/location/v1/beacon/name/:macaddress/:name
Requires OAuth
N
Parameters
Table 65: Parameter Details
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
Mac address of beacon.
name
String
pathReplace
New values to be used as
name.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
124
Location
GET: List of Beacons Matching Filter Criteria
GET: List of Beacons Matching Filter Criteria
Description
This API returns list of Beacons matching to filter criteria present on the given floor. filterString format
:mac={mac} name={name} uuid={uuid} major={major} minor={minor} example :
api/location/v1/veacon/search/{floorrefid}/mac=11:22:33:44:55:66 name=abc
HTTP Method
GET
Resource URI
/api/location/v1/beacon/search/:floorrefid/:filterString
Requires OAuth
N
Parameters
Table 66: Parameter Details
Name
Required
Default
Type
Location
Description
floorrefid
Number
pathReplace Reference id of the floor.
filterString
String
pathReplace Value of the filterString.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
125
Location
POST: Add Beacon with Minimum Fields
POST: Add Beacon with Minimum Fields
Description
This API adds a beacon with minimum fields to the store. Example query string /info/mac={mac} and
name={name} and uuid={uuid} and major={major} and minor={minor}.
HTTP Method
POST
Resource URI
/api/location/v1/beacon/info/:queryString
Requires OAuth
N
Parameters
Table 67: Parameter Details
Name
Required
Default
Type
Location
Description
queryString
String
pathReplace
Value of the
queryString.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
126
Location
GET: Beacons with Minimum Information for a Floor ID
GET: Beacons with Minimum Information for a Floor ID
Description
This API returns beacons with minimum information for a floor ID.
HTTP Method
GET
Resource URI
/api/location/v1/beacon/info/:floorrefid
Requires OAuth
N
Parameters
Table 68: Parameter Details
Name
Required
Default
Type
Location
Description
floorrefid
Number
pathReplace
Reference ID of
the floor.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
127
Location
GET: List of Beacons
GET: List of Beacons
Description
This API returns list of Beacons.
HTTP Method
GET
Resource URI
/api/location/v1/beacon
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
128
Location
GET: Beacon by MAC Address
GET: Beacon by MAC Address
Description
This API returns Beacon by macaddress.
HTTP Method
GET
Resource URI
/api/location/v1/beacon/:macaddress
Requires OAuth
N
Parameters
Table 69: Parameter Details
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
Mac address of
beacon.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
129
Location
DELETE: Delete Beacon by MAC Address
DELETE: Delete Beacon by MAC Address
Description
This API deletes a Beacon by macaddress.
HTTP Method
DELETE
Resource URI
/api/location/v1/beacon/:macaddress
Requires OAuth
N
Parameters
Table 70: Parameter Details
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
Mac address of
beacon to be
deleted.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
130
Location
PUT: Update Beacon
PUT: Update Beacon
Description
This API updates a given Beacon.
HTTP Method
PUT
Resource URI
/api/location/v1/beacon
Requires OAuth
N
Parameters
Table 71: Parameter Details
Name
Required
Default
Type
Location
Description
macAddress
string
body
MAC Address.
name
string
body
Name
type
enumerated
body
Known
Rogue
Unplaced
detectedOn
number
body
status
enumerated
body
detectedOn
Active
Missing
Misplaced
Inactive
NeverDetected
number
body
Last updated on.
expectedHierarchyString N
string
body
Expected Hierarchy
String.
lastUpdatedOn
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
131
Location
PUT: Update Beacon
Name
Required
Default
Type
Location
Description
actualHierarchyString N
string
body
Actual Hierarchy
String.
uuid
string
body
UUID
major
string
body
Major.
minor
string
body
Minor
manufacturerId
string
body
Manufacturer ID
rssi
string
body
RSSI value.
mapInfo
text
body
Map Information.
mapCoordinate
text
body
Map coordinate.
detectedLocation N
text
body
Detected Location.
configuredLocation N
text
body
Configured Location.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
132
Location
GET: List of Beacons Present on a Floor
GET: List of Beacons Present on a Floor
Description
This API returns list of Beacons present on the given floor.
HTTP Method
GET
Resource URI
/api/location/v1/beacon/floor/:floorrefid
Requires OAuth
N
Parameters
Table 72: Parameter Details
Name
Required
Default
Type
Location
Description
floorrefid
Number
pathReplace
Reference ID of
the floor.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
133
Location
POST: Add Beacon to the Store
POST: Add Beacon to the Store
Description
This API adds a Beacon to the store.
HTTP Method
POST
Resource URI
/api/location/v1/beacon
Requires OAuth
N
Parameters
Table 73: Parameter Details
Name
Required
Default
Type
Location
Description
macAddress
string
body
MAC Address.
name
string
body
type
enumerated
body
Known
Rogue
Unplaced
detectedOn
number
body
status
enumerated
body
Detected On.
Active
Missing
Misplaced
Inactive
NeverDetected
number
body
Last Updated on.
expectedHierarchyString N
string
body
Expected Hierarchy String.
lastUpdatedOn
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
134
Location
POST: Add Beacon to the Store
Name
Required
Default
Type
Location
Description
actualHierarchyString N
string
body
Actual Hierarchy String.
uuid
string
body
UUID
major
string
body
Major
minor
string
body
Minor
manufacturerId
string
body
Manufacturer ID
rssi
string
body
RSSI value.
mapInfo
text
body
Map Info.
mapCoordinate
text
body
Map coordinate.
detectedLocation
text
body
Detected Location.
configuredLocation N
text
body
Configured Location.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
135
Location
GET: Active Clients Count
GET: Active Clients Count
Description
This API returns active clients count.
HTTP Method
GET
Resource URI
/api/location/v2/clients/count
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
136
Location
GET: All clients
GET: All clients
Description
This API supports searching by ipv4/ipv6, mac-address and username. For example: Search by IPv4/IPv6:
api/location/v2/clients?ipAddress=x.x.x.x. Search by Mac Address: api/location/v2/clients?macAddress=x:x:x:x.
Search by Username: api/location/v2/clients?username=someUsername. This API also supports pagination
based on page and page size. Pagination: api/location/v2/clients?include=metadata and page=x and pageSize=x.
As long as there is data you can keep paginating by incrementing the page and the pageSize numbers. Sorting:
/api/location/v2/clients?sortBy=macAddress:ASC /api/location/v2/clients?sortBy=macAddress:DESC.
Supported values for sortBy param are 'lastLocatedTime', 'userName', 'macAddress', 'ssId' and 'dot11Status'.
HTTP Method
GET
Resource URI
/api/location/v2/clients
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
137
Location
GET: Collection of Active Clients MAC Address
GET: Collection of Active Clients MAC Address
Description
This API returns a collection of active client's MAC Address.
HTTP Method
GET
Resource URI
/api/location/v2/clients/active
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
138
Location
GET: Compact History of Client by Date and Username
GET: Compact History of Client by Date and Username
Description
This API returns compact history of client by date and username.
HTTP Method
GET
Resource URI
/api/location/v1/historylite/byusername/:username
Requires OAuth
N
Parameters
Table 74: Parameter Details
Name
Required
Default
Type
Location
Description
date
String
query
Date in format of
yyyy/mm/dd
username
String
pathReplace
User name.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
139
Location
GET: Unique MAC Address Seen on a Given Day on a Floor or Zone
GET: Unique MAC Address Seen on a Given Day on a Floor or
Zone
Description
This API returns the unique MAC address on a given dat on a floore or zone. It expects parameters date and
hierarchy. Hierarchy can be up to floor level or zone level. For example, floor level would include:
campus-name, building-name, and floor-name. Zone level would be campus-name, building-name, floor-name,
and zone-name. If you know the floorid or zone id, then hierarchy is optional and you can specify date and
floorid or date and zoneid parameters.
When date parameter is not specified, API would use current date as default. Specifying either of the parameters
like hierarchy or floorid or zoneid is mandatory. This API also supports filter by time and filter by distance
criterias. For filter by time, use fromHour and toHour (both in 24 hr format) parameters. For filter by distance
queries, using filter by time is mandatory and supported toHour/fromHour difference is 1 hr only to filter out
relevant data.
For examples:
By hierarchy:
/api/location/v1/history/uniqueclientsbyhierarchy?hierarchy=System%20Campus/Floor-19/1st%20Floor.
Floor ID:/api/location/v1/history/uniqueclientsbyhierarchy?floorid=730297895206534073.
By zoneid and date:/api/location/v1/history/uniqueclientsbyhierarchy?zoneid=23 and date=2016/02/29. By
hierarchy and filter by time:
/api/location/v1/history/uniqueclientsbyhierarchy?hierarchy=System%20Campus/BGLD-19/1st%20Floor
and fromHour=13 and toHour=14.
By hierarchy, filter by time and filter by distance:
/api/location/v1/history/uniqueclientsbyhierarchy?hierarchy=System%20Campus/BGLD-19/1st%20Floor
and fromHour=13 and toHour=14 and x=30 and y=50 and distance=10.
HTTP Method
GET
Resource URI
/api/location/v1/history/uniqueclientsbyhierarchy
Requires OAuth
N
Parameters
Table 75: Parameter Details
Name
Required
Default
Type
Location
Description
hierarchy
String
query
Hierarchy in format
campus-name/building-name/floor-name.
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
140
Location
GET: Unique MAC Address Seen on a Given Day on a Floor or Zone
Name
Required
Default
Type
Location
Description
date
String
query
Date in format of yyyy/mm/dd.
floorid
String
query
Floor ID.
zoneid
String
query
Zone ID.
fromHour
String
query
FromHour, HH in 24 hour
format.
toHour
String
query
ToHour, HH in 24 hour format
String
query
String
query
distance
String
query
Distance in feet
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
141
Location
GET: Compact History of Client By Date and IPv4 Address
GET: Compact History of Client By Date and IPv4 Address
Description
This API returns compact history of client by date and IPv4 address.
HTTP Method
GET
Resource URI
/api/location/v1/historylite/byipaddress/:ipv4address
Requires OAuth
N
Parameters
Table 76: Parameter Details
Name
Required
Default
Type
Location
Description
date
String
query
Date in format
of yyyy/mm/dd.
ipv4address
String
pathReplace
IPv4 Address.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
142
Location
GET: This API returns history for all clients
GET: This API returns history for all clients
Description
This API returns the history of all clients. It does not support pagination, but you can extract small chunks of
data by specifying parameters locatedAfterTime and locatedBeforeTime (in milliseconds).
For Example: This API would use the current date as date range from midnight to current time:
/api/location/v1/history/clients. This would use the passed date as date range from passed date + fromHour
to passed date + toHour: /api/location/v1/history/clients?date=2016/03/02 and fromHour=14 and toHour=15.
This would use the date range as mentioned by parameters: locatedAfterTime (1456894800000) milliseconds
equivalent to YYYY/MM/DD HH:MM:SS 2016/03/01 21:00:00. locatedBeforeTime (1456896600000)
milliseconds equivalent to YYYY/MM/DD HH:MM:SS 2016/03/01 21:30:00:
/api/location/v1/history/clients?locatedAfterTime=1456894800000 and locatedBeforeTime=1456896600000.
With CSCuz69078, when locatedAfterTime and locatedBeforeTime specified in API is more than a day and
less than an hour, the API returns the following error.
ERROR - Cassandra timeout during read query at consistency ONE (1 responses were required but only 0
replica responded)
For example,
https://<ip-address</api/location/v1/history/clients?locatedAfterTime=1459468800000&locatedBeforeTime=1459636800000
returns the ERROR.
HTTP Method
GET
Resource URI
/api/location/v1/history/clients
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
143
Location
GET: History of Client by MAC Address
GET: History of Client by MAC Address
Description
This API returns the history of a client by its MAC address.
HTTP Method
GET
Resource URI
/api/location/v1/history/clients/:macaddress
Requires OAuth
N
Parameters
Table 77: Parameter Details
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
Client
Macaddress.
date
String
query
Date in format
of yyyy/mm/dd.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
144
Presence
GET: Count of Passersby Today, page 149
GET: Count of Passersby Yesterday, page 150
GET: Average Count of Passersby in Last 3 Days, page 151
GET: Average Count of Passersby in the Last 7 days, page 152
GET: Average Count of Passersby in the Last 30 Days, page 153
GET: Sum of Passerby Counts in the Specified Date Range, page 154
GET: Sum of Passerby Counts in the Last 3 Days, page 155
GET: Sum of Passerby Counts in the Last 7 Days, page 156
GET: Count of Passersby on a Given Date, page 157
GET: Sum of Passerby Counts in the Last 30 days, page 158
GET: Hourly Count of Passersby Today, page 159
GET: Hourly Count of Passersby Yesterday, page 160
GET: Hourly Count of Passersby for Last 3 days, page 161
GET: Hourly Count of Passersby for a Day, page 162
GET: Daily Count of Passersby for a Specified Date Range, page 163
GET: Daily Count of Passersby for the Last 7 days, page 164
GET: Daily count of passersby for the last 30 days, page 165
GET: Daily Count of Passersby by hour for the Specified Date Range, page 166
GET: Excluded Client Counts, page 167
GET: Active Clients, page 168
GET: Client Detail, page 169
GET: Count of Connected Visitors for a Date, page 170
GET: Count of Connected Visitors Seen today Until Now, page 171
GET: Count of Connected Visitors Seen Yesterday, page 172
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
145
Presence
GET: Average Count of Connected Visitors Seen in Last 3 Days, page 173
GET: Average Count of Connected Visitors Seen in Last 7 Days, page 174
GET: Average Count of Connected Visitors seen in last 30 Days, page 175
GET: Sum of Connected Visitor Counts in Last 3 days, page 176
GET: Sum of Connected Visitor Counts in Last 7 days, page 177
GET: Sum of Connected Visitor Counts in Last 30 days, page 178
GET: Sum of Connected Visitor Counts in the Specified Date Range, page 179
GET: Hourly Count of Connected Visitors Today, page 180
GET: Hourly Count of Connected Visitors Yesterday, page 181
GET: Hourly Count of Connected Visitors in Last 3 Days, page 182
GET: Hourly Count of Connected Visitors for the Specified Day, page 183
GET: Daily Count of Connected Visitors for the Specified Date Range, page 184
GET: Daily Count of Connected Visitors for Last 7 days, page 185
GET: Daily Count of Connected Visitors for last 30 Days, page 186
GET: Daily Count of Connected Visitors by Hour for the Specified Date Range, page 187
GET: Site KPI Summary for Specified Date or Date Range, page 188
GET: Site KPI Summary for Today, page 189
GET: Site KPI Summary for Yesterday, page 190
GET: Site KPI Summary for Last 3 Days, page 191
GET: Site KPI Summary for last 7 days, page 192
GET: Site KPI Summary for Last 30 Days, page 193
GET: Site Insights for Specified Date or Date Range, page 194
GET: Average Count of Repeat Visitors for Last 7 Days, page 195
GET: Average Count of Repeat Visitors for Last 30 days, page 196
GET: Sum of Repeat Visitor Counts for Last 3 days, page 197
GET: Sum of Repeat Visitor Counts for Last 7 days, page 198
GET: Sum of Repeat Visitor Counts for Last 30 days, page 199
GET: Hourly Count of Repeat Visitors for a Day, page 200
GET: Hourly Count of Repeat Visitors Today, page 201
GET: Hourly Count of Repeat Visitors Yesterday, page 202
GET: Count of Repeat Visitors for a Date or Date Range, page 203
GET: Count of Repeat Visitors for Today, page 204
GET: Count of Repeat Visitors for Yesterday, page 205
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
146
Presence
GET: Average Count of Repeat Visitors for Last 3 days, page 206
GET: Average Count of Repeat Visitors for Specified Date Range, page 207
GET: Hourly Count of Repeat Visitors for Last 3 Days, page 208
GET: Repeat Visitor Summary for a Day, page 209
GET: Repeat Visitor Summary for a Week, page 210
GET: Repeat Visitor Summary for a Month, page 211
GET: Daily Count of Repeat Visitors for Specified Date Range, page 212
GET: Daily Count of Repeat Visitors for Last 7 Days, page 213
GET: Daily Count of Repeat Visitors for Last 30 days, page 214
GET: Peak Hour of Visitors Today, page 215
GET: Count of Visitors Today, page 216
GET: Count of Visitors Yesterday, page 217
GET: Count of Unique Visitors for Last 3 Days, page 218
GET: Count of Unique Visitors for Last Week, page 219
GET: Count of Unique Visitors for Last Month, page 220
GET: Count of Unique Visitors for a Date/Date Range, page 221
GET: Sum of Visitor Counts for a Date Range, page 222
GET: Sum of Visitor Counts for the Last 3 Days, page 223
GET: Sum of Visitor Counts for the Last Week, page 224
GET: Sum of Visitor Counts for the Last Month, page 225
GET: Hourly Count of Visitors Today, page 226
GET: Hourly Count of Visitors Yesterday, page 227
GET: Hourly Count of Visitors for Last 3 Days, page 228
GET: Hourly Count of Visitors for a Day, page 229
GET: Daily Count of Visitors for a Date Range, page 230
GET: Daily Count of Visitors for Last Week, page 231
GET: Daily Count of Visitors for Last Month, page 232
GET: Daily Count of Visitors by Hour Category for a Date Range, page 233
GET: Visitor Summary for a Day, page 234
GET: Visitor Summary for Week, page 235
GET: Visitor Summary for Month, page 236
GET: Count of Visitors by Dwell Level for a Date or Date Range, page 237
GET: Count of Visitors by Dwell Level for Today, page 238
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
147
Presence
GET: Count of Visitors by Dwell Level for Yesterday, page 239
GET: Count of Visitors by Dwell Level for Last 3 Days, page 240
GET: Count of Visitors by Dwell Level for Last 7 Days, page 241
GET: Count of Visitors by Dwell Level for Last 30 Days, page 242
GET: Average Count of Visitors by Dwell Level for Last 7 Days, page 243
GET: Average Count of Visitors by Dwell Level for Last 30 Days, page 244
GET: Hourly Count of Visitors by Dwell Level for a Specific Day, page 245
GET: Hourly Count of Visitors by Dwell Level for Today, page 246
GET: Average Visitor Dwell Time by Dwell Level for Last 7 Days, page 247
GET: Average Visitor Dwell Time by Dwell Level for Last 30 Days, page 248
GET: Daily Average Visitor Dwell Time by Dwell Level for a Specific Date Range, page 249
GET: Daily Average Visitor Dwell Time by Dwell Level for Last 7 Days, page 250
GET: Daily Average Visitor Dwell Time by Dwell Level for Last 30 Days, page 251
GET: Hourly Count of Visitors by Dwell level for Yesterday, page 252
GET: Hourly Count of Visitors by Dwell Level for Last 3 Days, page 253
GET: Daily Count of Visitors by Dwell Level for a Specific Date Range, page 254
GET: Daily Count of Visitors by Dwell Level for Last 7 Days, page 255
GET: Daily Count of Visitors by Dwell Level for Last 30 Days, page 256
GET: Average Visitor Dwell Time for the Specific Date or Date Range, page 257
GET: Average Visitor Dwell Time for Today, page 258
GET: Average Visitor Dwell Time for Yesterday, page 259
GET: Average Visitor Dwell Time for Last 3 Days, page 260
GET: Average Visitor Dwell Time for Last 7 Days, page 261
GET: Average Visitor Dwell Time for Last 30 Days, page 262
GET: Average Visitor Dwell Time by Dwell Level for a Specific Date or Date Range, page 263
GET: Average Visitor Dwell Time by Dwell Level for Today, page 264
GET: Average Visitor Dwell Time by Dwell Level for Yesterday, page 265
GET: Average Visitor Dwell Time by Dwell Level for Last 3 days, page 266
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
148
Presence
GET: Count of Passersby Today
GET: Count of Passersby Today
Description
This API returns the count of passersby seen today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/count/today
Requires OAuth
N
Parameters
Table 78: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
149
Presence
GET: Count of Passersby Yesterday
GET: Count of Passersby Yesterday
Description
This API returns the count of passersby seen yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/count/yesterday
Requires OAuth
N
Parameters
Table 79: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
150
Presence
GET: Average Count of Passersby in Last 3 Days
GET: Average Count of Passersby in Last 3 Days
Description
This API returns the average count of passersby seen in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/count/3days
Requires OAuth
N
Parameters
Table 80: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
151
Presence
GET: Average Count of Passersby in the Last 7 days
GET: Average Count of Passersby in the Last 7 days
Description
This API returns the average count of passersby seen in the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/count/lastweek
Requires OAuth
N
Parameters
Table 81: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
152
Presence
GET: Average Count of Passersby in the Last 30 Days
GET: Average Count of Passersby in the Last 30 Days
Description
This API returns the average count of passersby seen in the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/count/lastmonth
Requires OAuth
N
Parameters
Table 82: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
153
Presence
GET: Sum of Passerby Counts in the Specified Date Range
GET: Sum of Passerby Counts in the Specified Date Range
Description
This API returns the sum of passerby counts for each day in the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/total
Requires OAuth
N
Parameters
Table 83: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
154
Presence
GET: Sum of Passerby Counts in the Last 3 Days
GET: Sum of Passerby Counts in the Last 3 Days
Description
This API returns the sum of passerby counts for each day in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/total/3days
Requires OAuth
N
Parameters
Table 84: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
155
Presence
GET: Sum of Passerby Counts in the Last 7 Days
GET: Sum of Passerby Counts in the Last 7 Days
Description
This API returns the sum of passerby counts for each day in the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/total/lastweek
Requires OAuth
N
Parameters
Table 85: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
156
Presence
GET: Count of Passersby on a Given Date
GET: Count of Passersby on a Given Date
Description
This API returns the count of passersby seen on a given day.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/count
Requires OAuth
N
Parameters
Table 86: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
157
Presence
GET: Sum of Passerby Counts in the Last 30 days
GET: Sum of Passerby Counts in the Last 30 days
Description
This API returns the sum of passerby counts for each day in the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/total/lastmonth
Requires OAuth
N
Parameters
Table 87: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
158
Presence
GET: Hourly Count of Passersby Today
GET: Hourly Count of Passersby Today
Description
This API returns the hourly count of passersby today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/hourly/today
Requires OAuth
N
Parameters
Table 88: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
159
Presence
GET: Hourly Count of Passersby Yesterday
GET: Hourly Count of Passersby Yesterday
Description
This API returns the hourly count of passersby yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/hourly/yesterday
Requires OAuth
N
Parameters
Table 89: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
160
Presence
GET: Hourly Count of Passersby for Last 3 days
GET: Hourly Count of Passersby for Last 3 days
Description
This API returns the hourly count of passersby for the last 3 days including today.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/hourly/3days
Requires OAuth
N
Parameters
Table 90: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
161
Presence
GET: Hourly Count of Passersby for a Day
GET: Hourly Count of Passersby for a Day
Description
This API returns the hourly count of passersby for the specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/hourly
Requires OAuth
N
Parameters
Table 91: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
162
Presence
GET: Daily Count of Passersby for a Specified Date Range
GET: Daily Count of Passersby for a Specified Date Range
Description
This API returns the daily count of passersby for the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/daily
Requires OAuth
N
Parameters
Table 92: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
163
Presence
GET: Daily Count of Passersby for the Last 7 days
GET: Daily Count of Passersby for the Last 7 days
Description
This API returns the daily count of passersby for the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/daily/lastweek
Requires OAuth
N
Parameters
Table 93: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
164
Presence
GET: Daily count of passersby for the last 30 days
GET: Daily count of passersby for the last 30 days
Description
This API returns the daily count of passersby for the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/daily/lastmonth
Requires OAuth
N
Parameters
Table 94: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
165
Presence
GET: Daily Count of Passersby by hour for the Specified Date Range
GET: Daily Count of Passersby by hour for the Specified Date
Range
Description
This API returns the daily count of passersby by hour category for the specified date range
HTTP Method
GET
Resource URI
/api/presence/v1/passerby/daily/hourcategory
Requires OAuth
N
Parameters
Table 95: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
166
Presence
GET: Excluded Client Counts
GET: Excluded Client Counts
Description
This API returns the client counts excluded by filters.
HTTP Method
GET
Resource URI
/api/presence/v1/excluded
Requires OAuth
N
Parameters
Table 96: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
167
Presence
GET: Active Clients
GET: Active Clients
Description
This API returns the active clients seen in the last 20 minutes.
HTTP Method
GET
Resource URI
/api/presence/v1/clients
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
168
Presence
GET: Client Detail
GET: Client Detail
Description
This API returns the client detail for the specified MAC address.
HTTP Method
GET
Resource URI
/api/presence/v1/clients/:macaddress
Requires OAuth
N
Parameters
Table 97: Parameter Details
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
MAC address
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
169
Presence
GET: Count of Connected Visitors for a Date
GET: Count of Connected Visitors for a Date
Description
This API returns the count of connected visitors seen on a given day.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count
Requires OAuth
N
Parameters
Table 98: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
170
Presence
GET: Count of Connected Visitors Seen today Until Now
GET: Count of Connected Visitors Seen today Until Now
Description
This API returns the count of connected visitors seen today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count/today
Requires OAuth
N
Parameters
Table 99: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
171
Presence
GET: Count of Connected Visitors Seen Yesterday
GET: Count of Connected Visitors Seen Yesterday
Description
This API returns the count of connected visitors seen yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count/yesterday
Requires OAuth
N
Parameters
Table 100: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
172
Presence
GET: Average Count of Connected Visitors Seen in Last 3 Days
GET: Average Count of Connected Visitors Seen in Last 3 Days
Description
This API returns the average count of connected visitors seen in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count/3days
Requires OAuth
N
Parameters
Table 101: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
173
Presence
GET: Average Count of Connected Visitors Seen in Last 7 Days
GET: Average Count of Connected Visitors Seen in Last 7 Days
Description
This API returns the average count of connected visitors seen in the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count/lastweek
Requires OAuth
N
Parameters
Table 102: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
174
Presence
GET: Average Count of Connected Visitors seen in last 30 Days
GET: Average Count of Connected Visitors seen in last 30 Days
Description
This API returns the average count of connected visitors seen in the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count/lastmonth
Requires OAuth
N
Parameters
Table 103: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
175
Presence
GET: Sum of Connected Visitor Counts in Last 3 days
GET: Sum of Connected Visitor Counts in Last 3 days
Description
This API returns the the sum of connected visitor Counts for each day in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/total/3days
Requires OAuth
N
Parameters
Table 104: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
176
Presence
GET: Sum of Connected Visitor Counts in Last 7 days
GET: Sum of Connected Visitor Counts in Last 7 days
Description
This API returns the the sum of connected visitor counts for each day in the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/total/lastweek
Requires OAuth
N
Parameters
Table 105: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
177
Presence
GET: Sum of Connected Visitor Counts in Last 30 days
GET: Sum of Connected Visitor Counts in Last 30 days
Description
This API returns the the sum of connected visitor counts for each day in the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/total/lastmonth
Requires OAuth
N
Parameters
Table 106: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
178
Presence
GET: Sum of Connected Visitor Counts in the Specified Date Range
GET: Sum of Connected Visitor Counts in the Specified Date
Range
Description
This API returns the sum of connected visitor counts for each day in the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/total
Requires OAuth
N
Parameters
Table 107: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
179
Presence
GET: Hourly Count of Connected Visitors Today
GET: Hourly Count of Connected Visitors Today
Description
This API returns the hourly count of connected visitors today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/hourly/today
Requires OAuth
N
Parameters
Table 108: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
180
Presence
GET: Hourly Count of Connected Visitors Yesterday
GET: Hourly Count of Connected Visitors Yesterday
Description
This API returns the hourly count of connected visitors yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/hourly/yesterday
Requires OAuth
N
Parameters
Table 109: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
181
Presence
GET: Hourly Count of Connected Visitors in Last 3 Days
GET: Hourly Count of Connected Visitors in Last 3 Days
Description
This API returns the hourly count of connected visitors in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/hourly/3days
Requires OAuth
N
Parameters
Table 110: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
182
Presence
GET: Hourly Count of Connected Visitors for the Specified Day
GET: Hourly Count of Connected Visitors for the Specified Day
Description
This API returns the hourly count of connected visitors for the specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/hourly
Requires OAuth
N
Parameters
Table 111: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
183
Presence
GET: Daily Count of Connected Visitors for the Specified Date Range
GET: Daily Count of Connected Visitors for the Specified Date
Range
Description
This API returns the daily count of connected visitors for the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/daily
Requires OAuth
N
Parameters
Table 112: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
184
Presence
GET: Daily Count of Connected Visitors for Last 7 days
GET: Daily Count of Connected Visitors for Last 7 days
Description
This API returns the daily count of connected visitors for the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/daily/lastweek
Requires OAuth
N
Parameters
Table 113: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
185
Presence
GET: Daily Count of Connected Visitors for last 30 Days
GET: Daily Count of Connected Visitors for last 30 Days
Description
This API returns the daily count of connected visitors for the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/daily/lastmonth
Requires OAuth
N
Parameters
Table 114: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
186
Presence
GET: Daily Count of Connected Visitors by Hour for the Specified Date Range
GET: Daily Count of Connected Visitors by Hour for the Specified
Date Range
Description
This API returns the daily count of connected visitors by hour category for the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/daily/hourcategory
Requires OAuth
N
Parameters
Table 115: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
187
Presence
GET: Site KPI Summary for Specified Date or Date Range
GET: Site KPI Summary for Specified Date or Date Range
Description
This API returns the KPI summary for the given site and specified date or date range.
HTTP Method
GET
Resource URI
/api/presence/v1/kpisummary
Requires OAuth
N
Parameters
Table 116: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
188
Presence
GET: Site KPI Summary for Today
GET: Site KPI Summary for Today
Description
This API returns the KPI summary for the given site today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/kpisummary/today
Requires OAuth
N
Parameters
Table 117: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
189
Presence
GET: Site KPI Summary for Yesterday
GET: Site KPI Summary for Yesterday
Description
This API returns the KPI summary for the given site yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/kpisummary/yesterday
Requires OAuth
N
Parameters
Table 118: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
190
Presence
GET: Site KPI Summary for Last 3 Days
GET: Site KPI Summary for Last 3 Days
Description
This API returns the KPI summary for the given site for the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/kpisummary/3days
Requires OAuth
N
Parameters
Table 119: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
191
Presence
GET: Site KPI Summary for last 7 days
GET: Site KPI Summary for last 7 days
Description
This API returns the KPI summary for the given site for the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/kpisummary/lastweek
Requires OAuth
N
Parameters
Table 120: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
192
Presence
GET: Site KPI Summary for Last 30 Days
GET: Site KPI Summary for Last 30 Days
Description
This API returns the KPI summary for the given site for the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/kpisummary/lastmonth
Requires OAuth
N
Parameters
Table 121: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
193
Presence
GET: Site Insights for Specified Date or Date Range
GET: Site Insights for Specified Date or Date Range
Description
This API returns the insights for the given site and specified date or date range.
HTTP Method
GET
Resource URI
/api/presence/v1/insights
Requires OAuth
N
Parameters
Table 122: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
194
Presence
GET: Average Count of Repeat Visitors for Last 7 Days
GET: Average Count of Repeat Visitors for Last 7 Days
Description
This API returns the average count of repeat visitors seen in last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/average/lastweek
Requires OAuth
N
Parameters
Table 123: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
195
Presence
GET: Average Count of Repeat Visitors for Last 30 days
GET: Average Count of Repeat Visitors for Last 30 days
Description
This API returns the average count of repeat visitors seen in last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/average/lastmonth
Requires OAuth
N
Parameters
Table 124: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
196
Presence
GET: Sum of Repeat Visitor Counts for Last 3 days
GET: Sum of Repeat Visitor Counts for Last 3 days
Description
This API returns the sum of repeat visitor counts for each day in last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/count/3days
Requires OAuth
N
Parameters
Table 125: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
197
Presence
GET: Sum of Repeat Visitor Counts for Last 7 days
GET: Sum of Repeat Visitor Counts for Last 7 days
Description
This API returns the sum of repeat visitor counts for each day in last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/count/lastweek
Requires OAuth
N
Parameters
Table 126: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
198
Presence
GET: Sum of Repeat Visitor Counts for Last 30 days
GET: Sum of Repeat Visitor Counts for Last 30 days
Description
This API returns the sum of repeat visitor counts for each day in last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/count/lastmonth
Requires OAuth
N
Parameters
Table 127: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
199
Presence
GET: Hourly Count of Repeat Visitors for a Day
GET: Hourly Count of Repeat Visitors for a Day
Description
This API returns the hourly count of repeat visitors for the specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/hourly
Requires OAuth
N
Parameters
Table 128: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
200
Presence
GET: Hourly Count of Repeat Visitors Today
GET: Hourly Count of Repeat Visitors Today
Description
This API returns the hourly count of repeat visitors seen today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/hourly/today
Requires OAuth
N
Parameters
Table 129: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
201
Presence
GET: Hourly Count of Repeat Visitors Yesterday
GET: Hourly Count of Repeat Visitors Yesterday
Description
This API returns the hourly count of repeat visitors seen yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/hourly/yesterday
Requires OAuth
N
Parameters
Table 130: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
202
Presence
GET: Count of Repeat Visitors for a Date or Date Range
GET: Count of Repeat Visitors for a Date or Date Range
Description
This API returns the count of repeat visitors seen on a given day or date range.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/count
Requires OAuth
N
Parameters
Table 131: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
203
Presence
GET: Count of Repeat Visitors for Today
GET: Count of Repeat Visitors for Today
Description
This API returns the count of repeat visitors seen today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/count/today
Requires OAuth
N
Parameters
Table 132: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
204
Presence
GET: Count of Repeat Visitors for Yesterday
GET: Count of Repeat Visitors for Yesterday
Description
This API returns the count of repeat visitors seen yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/count/yesterday
Requires OAuth
N
Parameters
Table 133: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
205
Presence
GET: Average Count of Repeat Visitors for Last 3 days
GET: Average Count of Repeat Visitors for Last 3 days
Description
This API returns the average count of repeat visitors seen in last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/average/3days
Requires OAuth
N
Parameters
Table 134: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
206
Presence
GET: Average Count of Repeat Visitors for Specified Date Range
GET: Average Count of Repeat Visitors for Specified Date Range
Description
This API returns the average count of repeat visitors seen for the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/average
Requires OAuth
N
Parameters
Table 135: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
207
Presence
GET: Hourly Count of Repeat Visitors for Last 3 Days
GET: Hourly Count of Repeat Visitors for Last 3 Days
Description
This API returns the hourly count of repeat visitors for the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/hourly/3days
Requires OAuth
N
Parameters
Table 136: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
208
Presence
GET: Repeat Visitor Summary for a Day
GET: Repeat Visitor Summary for a Day
Description
This API returns the repeat visitor summary for the specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/daysummary
Requires OAuth
N
Parameters
Table 137: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
209
Presence
GET: Repeat Visitor Summary for a Week
GET: Repeat Visitor Summary for a Week
Description
This API returns the repeat visitor summary for the week of specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/weeksummary
Requires OAuth
N
Parameters
Table 138: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
210
Presence
GET: Repeat Visitor Summary for a Month
GET: Repeat Visitor Summary for a Month
Description
This API returns the repeat visitor summary for the month of specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/monthsummary
Requires OAuth
N
Parameters
Table 139: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
211
Presence
GET: Daily Count of Repeat Visitors for Specified Date Range
GET: Daily Count of Repeat Visitors for Specified Date Range
Description
This API returns the daily count of repeat visitors for the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/daily
Requires OAuth
N
Parameters
Table 140: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
212
Presence
GET: Daily Count of Repeat Visitors for Last 7 Days
GET: Daily Count of Repeat Visitors for Last 7 Days
Description
This API returns the daily count of repeat visitors for the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/daily/lastweek
Requires OAuth
N
Parameters
Table 141: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
213
Presence
GET: Daily Count of Repeat Visitors for Last 30 days
GET: Daily Count of Repeat Visitors for Last 30 days
Description
This API returns the daily count of repeat visitors for the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/repeatvisitors/daily/lastmonth
Requires OAuth
N
Parameters
Table 142: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
214
Presence
GET: Peak Hour of Visitors Today
GET: Peak Hour of Visitors Today
Description
This API returns the hour that had peak visitors today.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/today/peakhour
Requires OAuth
N
Parameters
Table 143: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
215
Presence
GET: Count of Visitors Today
GET: Count of Visitors Today
Description
This API returns the count of visitors seen today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/count/today
Requires OAuth
N
Parameters
Table 144: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
216
Presence
GET: Count of Visitors Yesterday
GET: Count of Visitors Yesterday
Description
This API returns the count of visitors seen yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/count/yesterday
Requires OAuth
N
Parameters
Table 145: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
217
Presence
GET: Count of Unique Visitors for Last 3 Days
GET: Count of Unique Visitors for Last 3 Days
Description
This API returns the count of unique visitors seen in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/count/3days
Requires OAuth
N
Parameters
Table 146: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
218
Presence
GET: Count of Unique Visitors for Last Week
GET: Count of Unique Visitors for Last Week
Description
This API returns the count of unique visitors seen in the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/count/lastweek
Requires OAuth
N
Parameters
Table 147: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
219
Presence
GET: Count of Unique Visitors for Last Month
GET: Count of Unique Visitors for Last Month
Description
This API returns the count of unique visitors seen in the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/count/lastmonth
Requires OAuth
N
Parameters
Table 148: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
220
Presence
GET: Count of Unique Visitors for a Date/Date Range
GET: Count of Unique Visitors for a Date/Date Range
Description
This API returns the count of unique visitors seen on a day or range of dates.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/count
Requires OAuth
N
Parameters
Table 149: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
221
Presence
GET: Sum of Visitor Counts for a Date Range
GET: Sum of Visitor Counts for a Date Range
Description
This API returns the sum of visitor counts for each day in the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/total
Requires OAuth
N
Parameters
Table 150: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start date
endDate
String
query
End date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
222
Presence
GET: Sum of Visitor Counts for the Last 3 Days
GET: Sum of Visitor Counts for the Last 3 Days
Description
This API returns the sum of visitor counts for each day in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/total/3days
Requires OAuth
N
Parameters
Table 151: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
223
Presence
GET: Sum of Visitor Counts for the Last Week
GET: Sum of Visitor Counts for the Last Week
Description
This API returns the sum of visitor counts for each day in the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/total/lastweek
Requires OAuth
N
Parameters
Table 152: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
224
Presence
GET: Sum of Visitor Counts for the Last Month
GET: Sum of Visitor Counts for the Last Month
Description
This API returns the sum of visitor counts for each day in the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/total/lastmonth
Requires OAuth
N
Parameters
Table 153: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
225
Presence
GET: Hourly Count of Visitors Today
GET: Hourly Count of Visitors Today
Description
This API returns the hourly count of visitors today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/hourly/today
Requires OAuth
N
Parameters
Table 154: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
226
Presence
GET: Hourly Count of Visitors Yesterday
GET: Hourly Count of Visitors Yesterday
Description
This API returns the hourly count of visitors yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/hourly/yesterday
Requires OAuth
N
Parameters
Table 155: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
227
Presence
GET: Hourly Count of Visitors for Last 3 Days
GET: Hourly Count of Visitors for Last 3 Days
Description
This API returns the hourly count of visitors for the last 3 days including today.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/hourly/3days
Requires OAuth
N
Parameters
Table 156: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
228
Presence
GET: Hourly Count of Visitors for a Day
GET: Hourly Count of Visitors for a Day
Description
This API returns the hourly count of visitors for the specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/hourly
Requires OAuth
N
Parameters
Table 157: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
229
Presence
GET: Daily Count of Visitors for a Date Range
GET: Daily Count of Visitors for a Date Range
Description
This API returns the daily count of unique visitors for the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/daily
Requires OAuth
N
Parameters
Table 158: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
230
Presence
GET: Daily Count of Visitors for Last Week
GET: Daily Count of Visitors for Last Week
Description
This API returns the daily count of visitors for the last 7 days including today.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/daily/lastweek
Requires OAuth
N
Parameters
Table 159: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
231
Presence
GET: Daily Count of Visitors for Last Month
GET: Daily Count of Visitors for Last Month
Description
This API returns the daily count of visitors for the last 30 days including today.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/daily/lastmonth
Requires OAuth
N
Parameters
Table 160: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
232
Presence
GET: Daily Count of Visitors by Hour Category for a Date Range
GET: Daily Count of Visitors by Hour Category for a Date Range
Description
This API returns the daily count of visitors seen during morning, business, evening hours for the specified
date range.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/daily/hourcategory
Requires OAuth
N
Parameters
Table 161: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
233
Presence
GET: Visitor Summary for a Day
GET: Visitor Summary for a Day
Description
This API returns a summary of visitor traffic for the specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/daysummary
Requires OAuth
N
Parameters
Table 162: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
234
Presence
GET: Visitor Summary for Week
GET: Visitor Summary for Week
Description
This API returns a summary of visitor traffic for the week of the specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/weeksummary
Requires OAuth
N
Parameters
Table 163: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
235
Presence
GET: Visitor Summary for Month
GET: Visitor Summary for Month
Description
This API returns a summary of visitor traffic for the month of the specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/monthsummary
Requires OAuth
N
Parameters
Table 164: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
236
Presence
GET: Count of Visitors by Dwell Level for a Date or Date Range
GET: Count of Visitors by Dwell Level for a Date or Date Range
Description
This API returns the count of visitors categorized by dwell level seen on a given day or date range.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/count
Requires OAuth
N
Parameters
Table 165: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
237
Presence
GET: Count of Visitors by Dwell Level for Today
GET: Count of Visitors by Dwell Level for Today
Description
This API returns the count of visitors categorized by dwell level seen today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/count/today
Requires OAuth
N
Parameters
Table 166: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
238
Presence
GET: Count of Visitors by Dwell Level for Yesterday
GET: Count of Visitors by Dwell Level for Yesterday
Description
This API returns the count of visitors categorized by dwell level seen yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/count/yesterday
Requires OAuth
N
Parameters
Table 167: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
239
Presence
GET: Count of Visitors by Dwell Level for Last 3 Days
GET: Count of Visitors by Dwell Level for Last 3 Days
Description
This API returns the count of visitors categorized by dwell level seen in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/count/3days
Requires OAuth
N
Parameters
Table 168: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
240
Presence
GET: Count of Visitors by Dwell Level for Last 7 Days
GET: Count of Visitors by Dwell Level for Last 7 Days
Description
This API returns the count of visitors categorized by dwell level seen in the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/count/lastweek
Requires OAuth
N
Parameters
Table 169: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
241
Presence
GET: Count of Visitors by Dwell Level for Last 30 Days
GET: Count of Visitors by Dwell Level for Last 30 Days
Description
This API returns the count of visitors categorized by dwell level seen in the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/count/lastmonth
Requires OAuth
N
Parameters
Table 170: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
242
Presence
GET: Average Count of Visitors by Dwell Level for Last 7 Days
GET: Average Count of Visitors by Dwell Level for Last 7 Days
Description
This API returns the average count of visitors categorized by dwell level seen in the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagecount/lastweek
Requires OAuth
N
Parameters
Table 171: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
243
Presence
GET: Average Count of Visitors by Dwell Level for Last 30 Days
GET: Average Count of Visitors by Dwell Level for Last 30 Days
Description
This API returns the average count of visitors categorized by dwell level seen in the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagecount/lastmonth
Requires OAuth
N
Parameters
Table 172: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
244
Presence
GET: Hourly Count of Visitors by Dwell Level for a Specific Day
GET: Hourly Count of Visitors by Dwell Level for a Specific Day
Description
This API returns the hourly count of visitors categorized by dwell level seen in the specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/hourly
Requires OAuth
N
Parameters
Table 173: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
245
Presence
GET: Hourly Count of Visitors by Dwell Level for Today
GET: Hourly Count of Visitors by Dwell Level for Today
Description
This API returns the hourly count of visitors categorized by dwell level seen today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/hourly/today
Requires OAuth
N
Parameters
Table 174: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
246
Presence
GET: Average Visitor Dwell Time by Dwell Level for Last 7 Days
GET: Average Visitor Dwell Time by Dwell Level for Last 7 Days
Description
This API returns the average visitor dwell time in minutes categorized by dwell level for last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagebylevel/lastweek
Requires OAuth
N
Parameters
Table 175: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
247
Presence
GET: Average Visitor Dwell Time by Dwell Level for Last 30 Days
GET: Average Visitor Dwell Time by Dwell Level for Last 30 Days
Description
This API returns the average visitor dwell time in minutes categorized by dwell level for last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagebylevel/lastmonth
Requires OAuth
N
Parameters
Table 176: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
248
Presence
GET: Daily Average Visitor Dwell Time by Dwell Level for a Specific Date Range
GET: Daily Average Visitor Dwell Time by Dwell Level for a
Specific Date Range
Description
This API returns the daily average visitor dwell time in minutes categorized by dwell level for the specified
date range.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/dailyaverage
Requires OAuth
N
Parameters
Table 177: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
249
Presence
GET: Daily Average Visitor Dwell Time by Dwell Level for Last 7 Days
GET: Daily Average Visitor Dwell Time by Dwell Level for Last
7 Days
Description
This API returns the daily average visitor dwell time in minutes categorized by dwell level for the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/dailyaverage/lastweek
Requires OAuth
N
Parameters
Table 178: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
250
Presence
GET: Daily Average Visitor Dwell Time by Dwell Level for Last 30 Days
GET: Daily Average Visitor Dwell Time by Dwell Level for Last
30 Days
Description
This API returns the daily average visitor dwell time in minutes categorized by dwell level for the last 30
days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/dailyaverage/lastmonth
Requires OAuth
N
Parameters
Table 179: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
251
Presence
GET: Hourly Count of Visitors by Dwell level for Yesterday
GET: Hourly Count of Visitors by Dwell level for Yesterday
Description
This API returns the hourly count of visitors categorized by dwell level seen yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/hourly/yesterday
Requires OAuth
N
Parameters
Table 180: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
252
Presence
GET: Hourly Count of Visitors by Dwell Level for Last 3 Days
GET: Hourly Count of Visitors by Dwell Level for Last 3 Days
Description
This API returns the hourly count of visitors categorized by dwell level seen in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/hourly/3days
Requires OAuth
N
Parameters
Table 181: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
253
Presence
GET: Daily Count of Visitors by Dwell Level for a Specific Date Range
GET: Daily Count of Visitors by Dwell Level for a Specific Date
Range
Description
This API returns the daily count of visitors categorized by dwell level seen during the specified date range
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/daily
Requires OAuth
N
Parameters
Table 182: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
254
Presence
GET: Daily Count of Visitors by Dwell Level for Last 7 Days
GET: Daily Count of Visitors by Dwell Level for Last 7 Days
Description
This API returns the daily count of visitors categorized by dwell level seen during the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/daily/lastweek
Requires OAuth
N
Parameters
Table 183: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
255
Presence
GET: Daily Count of Visitors by Dwell Level for Last 30 Days
GET: Daily Count of Visitors by Dwell Level for Last 30 Days
Description
This API returns the daily count of visitors categorized by dwell level seen during the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/daily/lastmonth
Requires OAuth
N
Parameters
Table 184: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
256
Presence
GET: Average Visitor Dwell Time for the Specific Date or Date Range
GET: Average Visitor Dwell Time for the Specific Date or Date
Range
Description
This API returns the average visitor dwell time in minutes for the specified date or date range.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/average
Requires OAuth
N
Parameters
Table 185: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
date
String
query
Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
257
Presence
GET: Average Visitor Dwell Time for Today
GET: Average Visitor Dwell Time for Today
Description
This API returns the average visitor dwell time in minutes for today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/average/today
Requires OAuth
N
Parameters
Table 186: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
258
Presence
GET: Average Visitor Dwell Time for Yesterday
GET: Average Visitor Dwell Time for Yesterday
Description
This API returns the average visitor dwell time in minutes for yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/average/yesterday
Requires OAuth
N
Parameters
Table 187: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
259
Presence
GET: Average Visitor Dwell Time for Last 3 Days
GET: Average Visitor Dwell Time for Last 3 Days
Description
This API returns the average visitor dwell time in minutes for last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/average/3days
Requires OAuth
N
Parameters
Table 188: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
260
Presence
GET: Average Visitor Dwell Time for Last 7 Days
GET: Average Visitor Dwell Time for Last 7 Days
Description
This API returns the average visitor dwell time in minutes for the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/average/lastweek
Requires OAuth
N
Parameters
Table 189: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
261
Presence
GET: Average Visitor Dwell Time for Last 30 Days
GET: Average Visitor Dwell Time for Last 30 Days
Description
This API returns the average visitor dwell time in minutes for the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/average/lastmonth
Requires OAuth
N
Parameters
Table 190: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
262
Presence
GET: Average Visitor Dwell Time by Dwell Level for a Specific Date or Date Range
GET: Average Visitor Dwell Time by Dwell Level for a Specific
Date or Date Range
Description
This API returns the average visitor dwell time in minutes categorized by dwell level for the specified date
or date range.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagebylevel
Requires OAuth
N
Parameters
Table 191: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
263
Presence
GET: Average Visitor Dwell Time by Dwell Level for Today
GET: Average Visitor Dwell Time by Dwell Level for Today
Description
This API returns the average visitor dwell time in minutes categorized by dwell level for today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagebylevel/today
Requires OAuth
N
Parameters
Table 192: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
264
Presence
GET: Average Visitor Dwell Time by Dwell Level for Yesterday
GET: Average Visitor Dwell Time by Dwell Level for Yesterday
Description
This API returns the average visitor dwell time in minutes categorized by dwell level for yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagebylevel/yesterday
Requires OAuth
N
Parameters
Table 193: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
265
Presence
GET: Average Visitor Dwell Time by Dwell Level for Last 3 days
GET: Average Visitor Dwell Time by Dwell Level for Last 3 days
Description
This API returns the average visitor dwell time in minutes categorized by dwell level for last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagebylevel/3days
Requires OAuth
N
Parameters
Table 194: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.2
266