Upload
vuongkien
View
261
Download
9
Embed Size (px)
Citation preview
Cisco Connected Mobile Experiences REST API Guide, Release 10.3First Published: 2017-04-02
Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAhttp://www.cisco.comTel: 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 LIMITEDWARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITHTHE 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 versionof the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDINGANYOTHERWARRANTYHEREIN, 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 OFMERCHANTABILITY, FITNESS FORA PARTICULAR PURPOSEANDNONINFRINGEMENTORARISING FROMACOURSEOFDEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUTLIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERSHAVE 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, networktopology 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 unintentionaland 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 partnershiprelationship between Cisco and any other company. (1110R)
© 2017 Cisco Systems, Inc. All rights reserved.
C O N T E N T S
C H A P T E R 1 Preface 1
Preface 1
Audience 1
Conventions 1
Related Documentation 2
Obtaining Documentation and Submitting a Service Request 2
C H A P T E R 2 Analytics 3
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas 4
POST: Breakdown of Connected and Detected Devices for a Given Period and Areas 10
POST: Paths for a Given Period and Areas 16
GET: All summary KPI 21
GET: Specific set of Summary KPIs or a list of available ones 22
POST: Overview Data for Target Areas for Brochure View 23
POST: Dwell Time for a Given Period and Areas 28
POST: Device Count for a Given Period and Areas 33
GET: Repeat Device Status for One Area 38
GET: Repeat Device Status for All Areas 39
GET: Repeat Device Status for One Area 40
GET: Repeat Device Status In Any Area (Detailed) 42
GET: Repeat Device Status for One Area (Abridged) 46
GET: Repeat Device Status In Any Area (Abridged) 48
GET: Retrieve the count of active clients on a floor or multiple floors right now. 50
POST: Retrieve the count of active clients on a floor or multiple floors right now. 51
POST: Retrieve the breakdown of connected and detected devices for a floor right now. 53
GET: Retrieve the breakdown of connected and detected devices for a floor right now. 55
GET: Get Count of Clients in Area 57
GET: Get Associated, Probing Count of Clients in Area 58
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 iii
C H A P T E R 3 Configuration 61
GET: Get Supported Northbound Notifications 64
GET: Current CMX Image Version 65
GET: Count of Active Alerts 66
GET: All Alerts 67
POST: Add Role to User 68
DELETE: Role from User 69
GET: All Users in the System 70
POST: Create a User 71
POST: Modify User 72
GET: User by Username 73
DELETE: User by Username 74
GET: All Roles 75
GET: All Campuses 76
GET: Campus by Name 77
PUT: Add Campus 78
GET: Count of All Map Elements 79
GET: List of all Building Names. 80
GET: List of all Building Names 81
GET: List of all Floor Names 82
GET: List of all Floor Names 83
GET: All Maps 84
GET: Campus by Name 85
GET: Building by Name Inside Specific Campus 86
GET: Floor Inside Specific Building and Specific Campus 87
GET: Floor Image 88
GET: Image by Name 89
GET: All Sites 90
GET: Site Details by ID or Name 91
GET: System Settings 92
PUT: System Settings 93
GET: All Notification Subscriptions 94
GET: Notifications by Name 95
GET: Notification Subscription Availability 96
Cisco Connected Mobile Experiences REST API Guide, Release 10.3iv
Contents
PUT: Add Notification Subscription 97
PUT: List of Notification Subscriptions 100
DELETE: Notification Subscription 101
GET: System Alert Subscription 102
GET: Notifications by Name 103
PUT: System Alert Subscription 104
DELETE: Notification Alert Subscription 107
POST: Change Status of Notification by Name 108
GET: Unique Alerts by Time Interval 109
GET: Alert by Time Interval 110
GET: Alerts by Time Interval and Hashkey 111
GET: Total Alerts Created for a Given Alert Key 112
GET: All APs 113
GET: Access Point by MAC Address 114
GET: Settings for a Given User 115
PUT: Setting for a Given User 116
GET: All Cisco WLC Controllers 117
GET: Get Cisco WLC Controllers by IP address 118
PUT: Controller 119
DELETE: All opt-out Devices 121
GET: List of Opt-out Devices Within a Date Range 122
GET: Count of opt-out Devices 123
DELETE: Opt-out Devices Within a Date Range 124
GET: List of Children Superzone IDs of a Hiterarchy Element 125
GET: Children Superzone IDs of Hiterarchy Element 127
GET: Gets the System Time 128
DELETE: Removes all registered zones 129
GET: Returns All Registered Zones 130
POST: Add New Zone 132
PUT: Add (Overwrite) New Zone 134
GET:Get All Subscriptions 136
POST: Add or Update Subscriptions 137
DELETE: Delete All Subscriptions 138
GET: Get Floors Managed by Controller 139
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 v
Contents
C H A P T E R 4 Connect 141
GET: Query User Sessions 142
C H A P T E R 5 Location 145
GET: Active RFID Tags Count 147
GET: All Tags 148
GET: RFID Tag by MAC Address 149
GET: Supported Northbound Notifications 150
GET: Count of all the Beacons 152
PUT: Place a Beacon at Detected Location on Map 153
PUT: Updates Name of a Given Beacon 154
GET: List of Beacons Matching Filter Criteria 155
POST: Add Beacon with Minimum Fields 156
GET: Beacons with Minimum Information for a Floor ID 157
GET: List of Beacons 158
GET: Beacon by MAC Address 159
DELETE: Delete Beacon by MAC Address 160
PUT: Update Beacon 161
GET: List of Beacons Present on a Floor 163
POST: Add Beacon to the Store 165
GET: Active Clients Count 167
GET: All clients 169
GET: Collection of Active Clients MAC Address 170
GET: Compact History of Client by Date and Username 171
GET: Unique MAC Address Seen on a Given Day on a Floor or Zone 173
GET: Compact History of Client By Date and IPv4 Address 175
GET: This API returns history for all clients 177
GET: History of Client by MAC Address 179
GET: Get all configuration compliance rules for client troubleshooting 180
GET: Get all configuration compliance rules for client troubleshooting from MAC 181
POST: Execute a compliance rule for troubleshooting 182
GET: Get interferer by macaddress 184
GET: Get total number of interferers 185
GET: Get all interferers 186
Cisco Connected Mobile Experiences REST API Guide, Release 10.3vi
Contents
GET: This API returns all RFID tags with minimal information 187
GET: Returns active clients count and mac addresses for each registered zone 188
GET: Returns active clients count for each registered zone 191
GET : Get Active APs 193
GET: Get Count of Active APs 194
GET: Get List of Missing APs 195
GET: Get Count of Missing APs 196
C H A P T E R 6 Presence 197
GET: Count of Passersby Today 201
GET: Count of Passersby Yesterday 202
GET: Average Count of Passersby in Last 3 Days 203
GET: Average Count of Passersby in the Last 7 days 204
GET: Average Count of Passersby in the Last 30 Days 205
GET: Sum of Passerby Counts in the Specified Date Range 206
GET: Sum of Passerby Counts in the Last 3 Days 207
GET: Sum of Passerby Counts in the Last 7 Days 208
GET: Count of Passersby on a Given Date 209
GET: Sum of Passerby Counts in the Last 30 days 210
GET: Hourly Count of Passersby Today 211
GET: Hourly Count of Passersby Yesterday 212
GET: Hourly Count of Passersby for Last 3 days 213
GET: Hourly Count of Passersby for a Day 215
GET: Daily Count of Passersby for a Specified Date Range 216
GET: Daily Count of Passersby for the Last 7 days 218
GET: Daily count of passersby for the last 30 days 220
GET: Daily Count of Passersby by hour for the Specified Date Range 222
GET: Excluded Client Counts 225
GET: Active Clients 226
GET: Client Detail 230
GET: Count of Connected Visitors for a Date 235
GET: Count of Connected Visitors Seen today Until Now 236
GET: Count of Connected Visitors Seen Yesterday 237
GET: Average Count of Connected Visitors Seen in Last 3 Days 238
GET: Average Count of Connected Visitors Seen in Last 7 Days 239
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 vii
Contents
GET: Average Count of Connected Visitors seen in last 30 Days 240
GET: Sum of Connected Visitor Counts in Last 3 days 241
GET: Sum of Connected Visitor Counts in Last 7 days 242
GET: Sum of Connected Visitor Counts in Last 30 days 243
GET: Sum of Connected Visitor Counts in the Specified Date Range 244
GET: Hourly Count of Connected Visitors Today 245
GET: Hourly Count of Connected Visitors Yesterday 246
GET: Hourly Count of Connected Visitors in Last 3 Days 247
GET: Hourly Count of Connected Visitors for the Specified Day 248
GET: Daily Count of Connected Visitors for the Specified Date Range 249
GET: Daily Count of Connected Visitors for Last 7 days 251
GET: Daily Count of Connected Visitors for last 30 Days 252
GET: Daily Count of Connected Visitors by Hour for the Specified Date Range 253
GET: Site KPI Summary for Specified Date or Date Range 255
GET: Site KPI Summary for Today 258
GET: Site KPI Summary for Yesterday 259
GET: Site KPI Summary for Last 3 Days 260
GET: Site KPI Summary for last 7 days 261
GET: Site KPI Summary for Last 30 Days 262
GET: Site Insights for Specified Date or Date Range 263
GET: Average Count of Repeat Visitors for Last 7 Days 266
GET: Average Count of Repeat Visitors for Last 30 days 267
GET: Sum of Repeat Visitor Counts for Last 3 days 268
GET: Sum of Repeat Visitor Counts for Last 7 days 269
GET: Sum of Repeat Visitor Counts for Last 30 days 270
GET: Hourly Count of Repeat Visitors for a Day 271
GET: Hourly Count of Repeat Visitors Today 272
GET: Hourly Count of Repeat Visitors Yesterday 273
GET: Count of Repeat Visitors for a Date or Date Range 274
GET: Count of Repeat Visitors for Today 275
GET: Count of Repeat Visitors for Yesterday 276
GET: Average Count of Repeat Visitors for Last 3 days 277
GET: Average Count of Repeat Visitors for Specified Date Range 278
GET: Hourly Count of Repeat Visitors for Last 3 Days 279
GET: Repeat Visitor Summary for a Day 280
Cisco Connected Mobile Experiences REST API Guide, Release 10.3viii
Contents
GET: Repeat Visitor Summary for a Week 281
GET: Repeat Visitor Summary for a Month 282
GET: Daily Count of Repeat Visitors for Specified Date Range 283
GET: Daily Count of Repeat Visitors for Last 7 Days 285
GET: Daily Count of Repeat Visitors for Last 30 days 286
GET: Peak Hour of Visitors Today 287
GET: Count of Visitors Today 288
GET: Count of Visitors Yesterday 289
GET: Count of Unique Visitors for Last 3 Days 290
GET: Count of Unique Visitors for Last Week 291
GET: Count of Unique Visitors for Last Month 292
GET: Count of Unique Visitors for a Date/Date Range 293
GET: Sum of Visitor Counts for a Date Range 294
GET: Sum of Visitor Counts for the Last 3 Days 295
GET: Sum of Visitor Counts for the Last Week 296
GET: Sum of Visitor Counts for the Last Month 297
GET: Hourly Count of Visitors Today 298
GET: Hourly Count of Visitors Yesterday 299
GET: Hourly Count of Visitors for Last 3 Days 300
GET: Hourly Count of Visitors for a Day 301
GET: Daily Count of Visitors for a Date Range 302
GET: Daily Count of Visitors for Last Week 303
GET: Daily Count of Visitors for Last Month 304
GET: Daily Count of Visitors by Hour Category for a Date Range 305
GET: Visitor Summary for a Day 307
GET: Visitor Summary for Week 308
GET: Visitor Summary for Month 309
GET: Count of Visitors by Dwell Level for a Date or Date Range 310
GET: Count of Visitors by Dwell Level for Today 311
GET: Count of Visitors by Dwell Level for Yesterday 312
GET: Count of Visitors by Dwell Level for Last 3 Days 313
GET: Count of Visitors by Dwell Level for Last 7 Days 314
GET: Count of Visitors by Dwell Level for Last 30 Days 315
GET: Average Count of Visitors by Dwell Level for Last 7 Days 316
GET: Average Count of Visitors by Dwell Level for Last 30 Days 317
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 ix
Contents
GET: Hourly Count of Visitors by Dwell Level for a Specific Day 318
GET: Hourly Count of Visitors by Dwell Level for Today 319
GET: Average Visitor Dwell Time by Dwell Level for Last 7 Days 320
GET: Average Visitor Dwell Time by Dwell Level for Last 30 Days 321
GET: Daily Average Visitor Dwell Time by Dwell Level for a Specific Date Range 322
GET: Daily Average Visitor Dwell Time by Dwell Level for Last 7 Days 324
GET: Daily Average Visitor Dwell Time by Dwell Level for Last 30 Days 325
GET: Hourly Count of Visitors by Dwell level for Yesterday 326
GET: Hourly Count of Visitors by Dwell Level for Last 3 Days 327
GET: Daily Count of Visitors by Dwell Level for a Specific Date Range 328
GET: Daily Count of Visitors by Dwell Level for Last 7 Days 330
GET: Daily Count of Visitors by Dwell Level for Last 30 Days 331
GET: Average Visitor Dwell Time for the Specific Date or Date Range 332
GET: Average Visitor Dwell Time for Today 333
GET: Average Visitor Dwell Time for Yesterday 334
GET: Average Visitor Dwell Time for Last 3 Days 335
GET: Average Visitor Dwell Time for Last 7 Days 336
GET: Average Visitor Dwell Time for Last 30 Days 337
GET: Average Visitor Dwell Time by Dwell Level for a Specific Date or Date Range 338
GET: Average Visitor Dwell Time by Dwell Level for Today 340
GET: Average Visitor Dwell Time by Dwell Level for Yesterday 341
GET: Average Visitor Dwell Time by Dwell Level for Last 3 days 342
Cisco Connected Mobile Experiences REST API Guide, Release 10.3x
Contents
Preface
• Preface, page 1
Preface
AudienceThis document is for network administrators who configure Cisco Connected Mobile Experiences (CiscoCMX) services.
ConventionsThis document uses the following conventions:
Table 1: Conventions
IndicationConvention
Commands and keywords and user-entered text appear in bold font.bold font
Document titles, new or emphasized terms, and arguments for which you supplyvalues are in italic font.
italic font
Elements in square brackets are optional.[ ]
Required alternative keywords are grouped in braces and separated by verticalbars.
{x | y | z }
Optional alternative keywords are grouped in brackets and separated by verticalbars.
[ x | y | z ]
A nonquoted set of characters. Do not use quotation marks around the string.Otherwise, the string will include the quotation marks.
string
Terminal sessions and information the system displays appear in courier font.courier font
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 1
IndicationConvention
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 codeindicates a comment line.
!, #
Means reader take note. Notes contain helpful suggestions or references to material not covered in themanual.
Note
Means the following information will help you solve a problem.Tip
Means reader be careful. In this situation, you might perform an action that could result in equipmentdamage or loss of data.
Caution
Related DocumentationFor 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-home.html
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
For more information about Cisco CMX Cloud, see:
https://support.cmxcisco.com/hc/en-us
Obtaining Documentation and Submitting a Service RequestFor information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a servicerequest, 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'sNew in Cisco Product Documentation RSS feed. RSS feeds are a free service.
Cisco Connected Mobile Experiences REST API Guide, Release 10.32
PrefaceRelated Documentation
Analytics
• POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas, page 4
• POST: Breakdown of Connected and Detected Devices for a Given Period and Areas, page 10
• POST: Paths for a Given Period and Areas, page 16
• GET: All summary KPI, page 21
• GET: Specific set of Summary KPIs or a list of available ones, page 22
• POST: Overview Data for Target Areas for Brochure View, page 23
• POST: Dwell Time for a Given Period and Areas, page 28
• POST: Device Count for a Given Period and Areas, page 33
• GET: Repeat Device Status for One Area, page 38
• GET: Repeat Device Status for All Areas, page 39
• GET: Repeat Device Status for One Area, page 40
• GET: Repeat Device Status In Any Area (Detailed), page 42
• GET: Repeat Device Status for One Area (Abridged), page 46
• GET: Repeat Device Status In Any Area (Abridged), page 48
• GET: Retrieve the count of active clients on a floor or multiple floors right now., page 50
• POST: Retrieve the count of active clients on a floor or multiple floors right now., page 51
• POST: Retrieve the breakdown of connected and detected devices for a floor right now., page 53
• GET: Retrieve the breakdown of connected and detected devices for a floor right now., page 55
• GET: Get Count of Clients in Area, page 57
• GET: Get Associated, Probing Count of Clients in Area, page 58
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 3
POST: Breakdown of Dwell Times Spent by Devices for a GivenPeriod and Areas
Description
The only parameter (body) is a JSON array containing the parameters. The parameters are described below:
Table 2: Parameter Details
Allowable Values/FormatsDescriptionJSON Array Parameter
• hourly
• daily
• weekly
• monthly
• yearly
• tag
• tag-name
• heterarchy level. One canlimit to top n results (that is,the n values with highestcount) by adding [n], or then bottom results by adding[n]
The desired granularity.granularity
Cisco Connected Mobile Experiences REST API Guide, Release 10.34
AnalyticsPOST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
Allowable Values/FormatsDescriptionJSON Array Parameter
• 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
The period of interest, specified aseither a date range, or one of thepredefined names.
period
• HH:mm-HH:mmThe time window of interest oneach day.
timeRange
• none
• sum
• avg
Aggregate the dwell time bygranularity, for example, showingthe total dwell time for each day ofthe week, instead of individualdates.
aggregate
A comma-separated list of areaIDs, or hierarchy levels.
The list of areas of interest. If noneare provided, all are considered.
areas
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 5
AnalyticsPOST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
Allowable Values/FormatsDescriptionJSON Array Parameter
Time (in minutes) in the formnn-mm where nn is the lower limitand mm the upper limit. Themaximum upper limit is 1440minutes; which is 24 hours, or afull day. Accepted Values:
• 0-240
• 0-480
• 0-1440
• 5-240
• 5-480
• 5-1440
• 10-240
• 10-480
• 10-1440
• 15-240
• 15-480
• 15-1440
• 30-240
• 30-480
• 30-1440
• 45-240
• 45-480
• 45-1440
• 60-240
• 60-480
• 60-1440
Filter devices by dwell times forwhich device visits specified areas.If a device's dwell time fallsoutside of the range, it is filteredout and not considered a visit.
durationCategories
• true
• false
Whether to include stationarydevices (default=false).
includeStationary
• connected
• detected
• all
Whether to restrict connection toeither connected or detecteddevices (default=all).
connectionState
Cisco Connected Mobile Experiences REST API Guide, Release 10.36
AnalyticsPOST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
Allowable Values/FormatsDescriptionJSON Array Parameter
Heterarchy levelIf set this parameter, does notreport absolute numbers, onlyrelative percentage.
percentageOf
• default
• minute
• comma separated limitlabel:limit value
The dwell time limit that specifieshow dwellers should be groupedtogether. Pass -1 to catch all.Example: Light: 100, Medium:200, Heavy:-1.
dwellLimits
• descendantOf
• subsetOf:comma separatedids
If set this parameter, restricts theresults to areas matching the filter.Use descendantOf to restrict thearea selection. This option is usedfor drill-down reports. Use'subsetOf' to restrict the granularity.This option is used with taggranularity.For example: descendantOf:Campus C1 has Building B1whichzone Z1 and Z2 Campus C2 hasBuilding B2 which zone Z3 queryarea=Z1,Z2,Z3 andgranularity=Building andareaFilter=descendantOf:C1 willreturn only Building B1
For example: subsetOf: Tag T1,T2assigned to F1, T2,T3 to F2, T3,T4to F3 query area=F1,F2,F3 andgranularity=tag andareaFilter=subsetOf:T1,T2 willreturn only T1,T2.
areaFilter
• true
• false
Include all the elementsdescendants in the result.
expandAll
HTTP Method
POST
Resource URI
/api/analytics/v1/dwellBreakdown
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 7
AnalyticsPOST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
Requires OAuth
N
Parameters
Table 3: Parameter Details
DescriptionLocationTypeDefaultRequiredName
JSON arraycontainingparameters.
bodyJSON array—Ybody
Content Type
application/json
Sample Input (JSON){"period": "today","timeRange": "00:00-23:59","granularity": "hourly","areas": "52,75"}
Sample Output (JSON){"startTime": "00:00","startDate": "2017-03-16","results": [{"id": 53,"ancestry": [{"level": "Building","name": "REQ"
},{"level": "Campus","name": "Richfield"
}],"series": ["datetime","dwell"
],"hasChildren": false,"area": "2nd Floor","data": []
},{"id": 75,"ancestry": [{"level": "Floor","name": "Site 4"
},{"level": "Building","name": "Site 4"
Cisco Connected Mobile Experiences REST API Guide, Release 10.38
AnalyticsPOST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
},{"level": "Campus","name": "San Jose Outdoor"
}],"series": ["datetime","dwell"
],"hasChildren": false,"area": "f4:0f:1b:1a:82:90","data": []
}],"interval": "hourly","executionTime": 0,"insights": {"summary": {}
},"endDate": "2017-03-16","maxValues": {},"endTime": "23:59","dataFreshness": "2017-03-16T02:53:58.054-07:00","minValues": {}
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 9
AnalyticsPOST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
POST: Breakdown of Connected and Detected Devices for aGiven Period and Areas
Description
The only parameter (body) is a JSON array containing the parameters. The parameters are described below
Table 4: Parameter Details
Allowable values/formatsDescriptionJSON array parameter
• hourly
• daily
• weekly
• monthly
• yearly
• tag
• tag-name
• heterarchy level
• null
The desired granularity. One canlimit to top n results (i.e. the nvalues with highest count) byadding "[n]", or the n bottomresults by adding "[-n"]. Ifgranularity null is specified, allheterarchy types covered by theareas are returned.
granularity
• 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
The period of interest, eitherspecified as a date range, or one ofthe predefined names
period
Cisco Connected Mobile Experiences REST API Guide, Release 10.310
AnalyticsPOST: Breakdown of Connected and Detected Devices for a Given Period and Areas
Allowable values/formatsDescriptionJSON array parameter
• HH:mm-HH:mmThe time window of interest oneach day.
timeRange
• none
• sum
• avg
Whether to aggregate the dwelltime by granularity; e.g. showinga total for each day of the week,instead of individual dates
aggregate
A comma-separated list of area ids,or heterarchy levels<areaId><areaId-1>,<areaId-2>,<areaId-3>
The list of areas of interest. If noneare given, all are considered
areas
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 11
AnalyticsPOST: Breakdown of Connected and Detected Devices for a Given Period and Areas
Allowable values/formatsDescriptionJSON array parameter
Time (in minutes) in the formnn-mm where nn is the lower limitand mm the upper limit. Themaximum upper limit is 1440minutes; which is 24 hours, or afull day. Accepted Values:
• 0-240
• 0-480
• 0-1440
• 5-240
• 5-480
• 5-1440
• 10-240
• 10-480
• 10-1440
• 15-240
• 15-480
• 15-1440
• 30-240
• 30-480
• 30-1440
• 45-240
• 45-480
• 45-1440
• 60-240
• 60-480
• 60-1440
Filter devices by dwell times forwhich device visits specified areas.If a device's dwell time fallsoutside of the range, it is filteredout and not considered a visit.
durationCategories
• true
• false
Whether to include stationarydevices (default=false)
includeStationary
Heterarchy levelIf set, does not report absolutenumbers, but relative percentage
percentageOf
Cisco Connected Mobile Experiences REST API Guide, Release 10.312
AnalyticsPOST: Breakdown of Connected and Detected Devices for a Given Period and Areas
Allowable values/formatsDescriptionJSON array parameter
• descendantOf
• subsetOf:comma separatedids
If set, restricts the results to areasmatching the filter. Use'descendantOf' to restrict the areaselection. This option is used fordrill down reports. Use 'subsetOf'to restrict the granularity. Thisoption is used with tag granularity.For example: descendantOf:Campus C1 has Building B1whichzone Z1 and Z2 Campus C2 hasBuilding B2 which zone Z3 queryarea=Z1,Z2,Z3 andgranularity=Building andareaFilter=descendantOf:C1 willreturn only Building B1
For example: subsetOf: Tag T1,T2assigned to F1, T2,T3 to F2, T3,T4to F3 query area=F1,F2,F3 andgranularity=tag andareaFilter=subsetOf:T1,T2 willreturn only T1,T2.
areaFilter
• true
• false
Include all of the elementsdescendants in the result
expandAll
HTTP Method
POST
Resource URI
/api/analytics/v1/connectedDetected
Requires OAuth
N
Parameters
Table 5: Parameter Details
DescriptionLocationTypeDefaultRequiredName
JSON arraycontainingparameters.
bodyJSON array—Ybody
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 13
AnalyticsPOST: Breakdown of Connected and Detected Devices for a Given Period and Areas
Content Type
application/json
Sample Input (JSON){"period": "today","timeRange": "00:00-23:59","granularity": "hourly","areas": "5786"}
Sample Output (JSON){"startTime": "00:00","startDate": "2017-03-16","results": [{"id": 5786,"ancestry": [{"level": "Campus","name": "Nortech Campus"
}],"startDate": "2017-03-16","series": ["datetime"
],"hasChildren": true,"area": "Nortech-1","data": [{"dwell": null,"values": {"connected": 0,"detected": 0
},"name": null
},{"dwell": null,"values": {"connected": 0,"detected": 0
},"name": null
},{"dwell": null,"values": {"connected": 0,"detected": 0
},"name": null
},{"dwell": null,"values": {"connected": 0,"detected": 0
},"name": null,"incomplete": true
}]
Cisco Connected Mobile Experiences REST API Guide, Release 10.314
AnalyticsPOST: Breakdown of Connected and Detected Devices for a Given Period and Areas
}],"interval": "hourly","executionTime": 18,"insights": {"summary": {},"connected": {"ancestry": [{"level": "Campus","name": "Nortech Campus"
}],"id": 5786,"index": 0,"maxDate": "2017-03-16","name": "Nortech-1","maxTime": "00:00","maxValue": 0
},"detected": {"ancestry": [{"level": "Campus","name": "Nortech Campus"
}],"id": 5786,"index": 0,"maxDate": "2017-03-16","name": "Nortech-1","maxTime": "00:00","maxValue": 0
}},"endDate": "2017-03-16","maxValues": {"connected": 0,"detected": 0
},"endTime": "23:59","dataFreshness": "2017-03-16T02:53:55.919-07:00","minValues": {"connected": 0,"detected": 0
}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 15
AnalyticsPOST: Breakdown of Connected and Detected Devices for a Given Period and Areas
POST: Paths for a Given Period and AreasDescription
The only parameter (body) is a JSON array containing the parameters. The parameters are described below:
Table 6: Parameter Details
Allowable values/formatsDescriptionJSON array parameter
• 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
The period of interest, eitherspecified as a date range, or one ofthe predefined names
period
• HH:mm-HH:mmThe time window of interest oneach day.
timeRange
The ID of the target area for thepaths.
The id of the target area for thepaths.
targetArea
A comma-separated list of area IDs<areaId-1>,<areaId-2>,<areaId-3>
The list of areas of interest.allAreas
Heterarchy levelThe desired geographicalgranularity. This will replace theareas listed in 'allAreas' withtheirprogeny on the appropriate level.
granularity
Cisco Connected Mobile Experiences REST API Guide, Release 10.316
AnalyticsPOST: Paths for a Given Period and Areas
Allowable values/formatsDescriptionJSON array parameter
Time (in minutes) in the formnn-mm where nn is the lower limitand mm the upper limit. Themaximum upper limit is 1440minutes; which is 24 hours, or afull day. Accepted Values:
• 0-240
• 0-480
• 0-1440
• 5-240
• 5-480
• 5-1440
• 10-240
• 10-480
• 10-1440
• 15-240
• 15-480
• 15-1440
• 30-240
• 30-480
• 30-1440
• 45-240
• 45-480
• 45-1440
• 60-240
• 60-480
• 60-1440
Filter devices by dwell times forwhich device visits specified areas.If a device's dwell time fallsoutside of the range, it is filteredout and not considered a visit.
durationCategories
HTTP Method
POST
Resource URI
/api/analytics/v1/path
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 17
AnalyticsPOST: Paths for a Given Period and Areas
Requires OAuth
N
Parameters
Table 7: Parameter Details
DescriptionLocationTypeDefaultRequiredName
JSON arraycontainingparameters.
bodyJSON array—Ybody
Content Type
application/json
Sample Input (JSON){
"period": "today","timeRange": "00:00-23:59","granularity": "Building","allAreas": "52,75,80"
}
Sample Output (JSON)/* Path Output */{
"startTime": "00:00","startDate": "2017-03-07","results": [
{"id": 75,"total": 0,"medianTransitionTime": 0,"ancestry": [
{"level": "Campus","name": "TagTest_Campus_1"
}],"area": "TagTest_Building_1","direction": -1,"value": 0,"averageTransitionTime": 0
},{
"id": 80,"total": 0,"medianTransitionTime": 0,"ancestry": [
{"level": "Campus","name": "TagTest_Campus_1"
}],"area": "TagTest_Building_2","direction": -1,"value": 0,
Cisco Connected Mobile Experiences REST API Guide, Release 10.318
AnalyticsPOST: Paths for a Given Period and Areas
"averageTransitionTime": 0},{
"id": 75,"total": 0,"medianTransitionTime": 0,"ancestry": [
{"level": "Campus","name": "TagTest_Campus_1"
}],"area": "TagTest_Building_1","direction": 1,"value": 0,"averageTransitionTime": 0
},{
"id": 80,"total": 0,"medianTransitionTime": 0,"ancestry": [
{"level": "Campus","name": "TagTest_Campus_1"
}],"area": "TagTest_Building_2","direction": 1,"value": 0,"averageTransitionTime": 0
}],"executionTime": 88,"requestTruncated": false,"target": {
"ancestry": [{
"level": "Campus","name": "campus"
}],"total": 0,"id": 52,"area": "Building_0","pathsEnded": 0,"totalVisits": 0,"pathsStarted": 0,"avgDwellPerDevice": 0,"avgDwellPerVisit": 0,"totalDevices": 0
},"insights": {},"endDate": "2017-03-07","endTime": "23:59","dataFreshness": {
"dayOfYear": 66,"dayOfMonth": 7,"dayOfWeek": 2,"era": 1,"year": 2017,"minuteOfDay": 1277,"hourOfDay": 21,"weekyear": 2017,"monthOfYear": 3,"yearOfEra": 2017,"yearOfCentury": 17,"centuryOfEra": 20,"millisOfSecond": 782,"millisOfDay": 76673782,"secondOfMinute": 53,"secondOfDay": 76673,"minuteOfHour": 17,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 19
AnalyticsPOST: Paths for a Given Period and Areas
"weekOfWeekyear": 10,"millis": 1488921473782,"zone": {
"fixed": true,"id": "Etc/UTC"
},"chronology": {
"zone": {"fixed": true,"id": "Etc/UTC"
}},"afterNow": false,"beforeNow": false,"equalNow": true
}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.320
AnalyticsPOST: Paths for a Given Period and Areas
GET: All summary KPIDescription
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.3 21
AnalyticsGET: All summary KPI
GET: Specific set of Summary KPIs or a list of available onesDescription
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 8: Parameter Details
DescriptionLocationTypeDefaultRequiredName
A comma-separated list ofsummary KPI to return, or'availableMetrics' to see thelist of metrics available.
pathReplaceString—YsummaryItem
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.322
AnalyticsGET: Specific set of Summary KPIs or a list of available ones
POST: Overview Data for Target Areas for Brochure ViewDescription
The only parameter (body) is a JSON array containing the parameters. The parameters are described below
Table 9: Parameter Details
Allowable values/formatsDescriptionJSON array parameter
• deviceCount
• deviceDwell
• grossShopping
• deviceCrossover
• connectedDetected
• dwellBreakdown
The type of data requestedtype
• 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
The period of interest, eitherspecified as a date range, or one ofthe predefined names
period
• HH:mm-HH:mmThe time window of interest oneach day
timeRange
A comma-separated list of area ids,or heterarchy levels
The list of areas of interest. If noneare given, all are considered
areas
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 23
AnalyticsPOST: Overview Data for Target Areas for Brochure View
Allowable values/formatsDescriptionJSON array parameter
Time (in minutes) in the formnn-mm where nn is the lower limitand mm the upper limit. Themaximum upper limit is 1440minutes; which is 24 hours, or afull day. Accepted Values:
• 0-240
• 0-480
• 0-1440
• 5-240
• 5-480
• 5-1440
• 10-240
• 10-480
• 10-1440
• 15-240
• 15-480
• 15-1440
• 30-240
• 30-480
• 30-1440
• 45-240
• 45-480
• 45-1440
• 60-240
• 60-480
• 60-1440
Filter devices by dwell times forwhich device visits specified areas.If a device's dwell time fallsoutside of the range, it is filteredout and not considered a visit.
durationCategories
• true
• false
Whether to include stationarydevices (default=false)
includeStationary
Cisco Connected Mobile Experiences REST API Guide, Release 10.324
AnalyticsPOST: Overview Data for Target Areas for Brochure View
Allowable values/formatsDescriptionJSON array parameter
• true
• false
Whether to include device visitsthat occur any time during theentire period or only within a singleday (default=false).Applicable only to crossover;ignored for the other metrics.
entirePeriod
• connected
• detected
• all
Whether to restrict to eitherconnected or detected devices(default=all).For Connected/Detected metric,this setting is ignored, and "all" ispresumed
connectionState
Heterarchy levelIf set, does not report absolutenumbers, but relative percentage.Ignored for Crossover report
percentageOf
• default
• minute
• Light:<limit>,Medium:<limit>,Heavy:<limit>
• comma separated limitlabel:limit value
The dwell time limits that specifieshow dwellers should be groupedtogether. Values are commaseperated as key:value pairs. Keyis the series name and value is theupper dwell time limit of the series.For example,Light:5,Medium:20,Heavy:100would mean that you considerdevices that dwell for less than 5minutes to be Light; from 5minutes to 20 minutes to beMedium; and from 20 minutes to100 to be Heavy. If you want toconsider all dwells, pass in -1 asthe value.
dwellLimits
HTTP Method
POST
Resource URI
/api/analytics/v1/overview
Requires OAuth
N
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 25
AnalyticsPOST: Overview Data for Target Areas for Brochure View
Parameters
Table 10: Parameter Details
DescriptionLocationTypeDefaultRequiredName
JSON arraycontainingparameters
bodyJSON array—Ybody
Content Type
application/json
Sample Input (JSON){"period": "today","timeRange": "00:00-23:59","areas": "52","type": "deviceCount"}
Sample Output (JSON){"startTime": "00:00","previousEndDate": null,"startDate": "2017-03-16","title": "Visitors","executionTime": 32,"value": {"primary": {"title": "Total Visitors","value": 0,"peakValue": 0,"breakdown": [{"title": "Repeat Visitors","value": 0
},{"title": "New Visitors","value": 0
}]
},"average": {"title": "Total Visitors","value": 0,"peakValue": 0,"breakdown": [{"title": "Repeat Visitors","value": 0
},{"title": "New Visitors","value": 0
}]
},"previousTimeRange": {"title": "Total Visitors",
Cisco Connected Mobile Experiences REST API Guide, Release 10.326
AnalyticsPOST: Overview Data for Target Areas for Brochure View
"value": 0,"peakValue": 0,"breakdown": [{"title": "Repeat Visitors","value": 0
},{"title": "New Visitors","value": 0
}]
}},"areas": [{"id": 52,"name": "f0:25:72:3c:f8:10"
}],"previousStartDate": "2017-03-15","endDate": null,"endTime": "23:59"
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 27
AnalyticsPOST: Overview Data for Target Areas for Brochure View
POST: Dwell Time for a Given Period and AreasDescription
The only parameter is a JSON array containing the parameters. The parameters are described below
Table 11: Parameter Details
Allowable values/formatsDescriptionJSON array parameter
• hourly
• daily
• weekly
• monthly
• yearly
• tag
• tag-name
• heterarchy level
• null
The desired granularity. One canlimit to top n results (i.e. the nvalues with highest count) byadding "[n]", or the n bottomresults by adding "[-n"]. Ifgranularity null is specified, allheterarchy types covered by theareas are returned.
granularity
• 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
The period of interest, eitherspecified as a date range, or one ofthe predefined names
period
• HH:mm-HH:mmThe time window of interest oneach day
timeRange
Cisco Connected Mobile Experiences REST API Guide, Release 10.328
AnalyticsPOST: Dwell Time for a Given Period and Areas
Allowable values/formatsDescriptionJSON array parameter
• none
• sum
• avg
Whether to aggregate the dwelltime by granularity; e.g. showinga total for each day of the week,instead of individual dates
aggregate
A comma-separated list of area ids,or heterarchy levels<areaId><areaId-1>,<areaId-2>,<areaId-3>
The list of areas of interest. If noneare given, all are considered
areas
Time (in minutes) in the formnn-mm where nn is the lower limitand mm the upper limit. Themaximum upper limit is 1440minutes; which is 24 hours, or afull day. Accepted Values:
• 0-240
• 0-480
• 0-1440
• 5-240
• 5-480
• 5-1440
• 10-240
• 10-480
• 10-1440
• 15-240
• 15-480
• 15-1440
• 30-240
• 30-480
• 30-1440
• 45-240
• 45-480
• 45-1440
• 60-240
• 60-480
• 60-1440
Filter devices by dwell times forwhich device visits specified areas.If a device's dwell time fallsoutside of the range, it is filteredout and not considered a visit.
durationCategories
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 29
AnalyticsPOST: Dwell Time for a Given Period and Areas
Allowable values/formatsDescriptionJSON array parameter
• true
• false
Whether to include stationarydevices
includeStationary
• connected
• detected
• all
Whether to restrict to eitherconnected or detected devices(default=all)
connectionState
Heterarchy levelIf set, does not report absolutenumbers, but relative percentage
percentageOf
• descendantOf
• subsetOf:comma separatedids
If set, restricts the results to areasmatching the filter. Use'descendantOf' to restrict the areaselection. This option is used fordrill down reports. Use 'subsetOf'to restrict the granularity. Thisoption is used with tag granularity.For example: descendantOf:Campus C1 has Building B1whichzone Z1 and Z2 Campus C2 hasBuilding B2 which zone Z3 queryarea=Z1,Z2,Z3 andgranularity=Building andareaFilter=descendantOf:C1 willreturn only Building B1
For example: subsetOf: Tag T1,T2assigned to F1, T2,T3 to F2, T3,T4to F3 query area=F1,F2,F3 andgranularity=tag andareaFilter=subsetOf:T1,T2 willreturn only T1,T2.
areaFilter
• true
• false
Include all of the elementsdescendants in the result
expandAll
HTTP Method
POST
Resource URI
/api/analytics/v1/deviceDwell
Cisco Connected Mobile Experiences REST API Guide, Release 10.330
AnalyticsPOST: Dwell Time for a Given Period and Areas
Requires OAuth
N
Parameters
Table 12: Parameter Details
DescriptionLocationTypeDefaultRequiredName
JSON arraycontainingparameters.
bodyJSON array—Ybody
Content Type
application/json
Sample Input (JSON){"period": "today","timeRange": "00:00-23:59","granularity": "hourly","areas": "52,75"}
Sample Output (JSON){"startTime": "00:00","startDate": "2017-03-16","connectionState": "all","results": [{"id": 53,"ancestry": [{"level": "Building","name": "REQ"
},{"level": "Campus","name": "Richfield"
}],"series": ["datetime"
],"hasChildren": false,"level": "FLOOR","area": "2nd Floor","data": []
},{"id": 75,"ancestry": [{"level": "Floor","name": "Site 4"
},{"level": "Building",
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 31
AnalyticsPOST: Dwell Time for a Given Period and Areas
"name": "Site 4"},{"level": "Campus","name": "San Jose Outdoor"
}],"series": ["datetime"
],"hasChildren": false,"level": "AP","area": "f4:0f:1b:1a:82:90","data": []
}],"interval": "hourly","executionTime": 0,"minValue": 2147483647,"endDate": "2017-03-16","endTime": "23:59","dataFreshness": "2017-03-16T02:58:04.319-07:00","maxValue": 0
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.332
AnalyticsPOST: Dwell Time for a Given Period and Areas
POST: Device Count for a Given Period and AreasDescription
The only parameter (body) is a JSON array containing the parameters. The parameters are described below
Use the Postman Client for REST API to test or implement this API.Note
Table 13: Parameter Details
Allowable values/formatsDescriptionJSON array parameter
• hourly
• daily
• weekly
• monthly
• yearly
• tag
• tag-name
• heterarchy level
• null
The desired granularity. One canlimit to top n results (i.e. the nvalues with highest count) byadding "[n]", or the n bottomresults by adding "[-n"]. Ifgranularity null is specified, allheterarchy types covered by theareas are returned.
granularity
• 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
The period of interest, eitherspecified as a date range, or one ofthe predefined names
period
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 33
AnalyticsPOST: Device Count for a Given Period and Areas
Allowable values/formatsDescriptionJSON array parameter
• HH:mm-HH:mmThe time window of interest oneach day.
timeRange
• none
• sum
• avg
Whether to aggregate the dwelltime by granularity; e.g. showinga total for each day of the week,instead of individual dates
aggregate
A comma-separated list of area ids,or heterarchy levels
The list of areas of interest. If noneare given, all are considered
areas
Cisco Connected Mobile Experiences REST API Guide, Release 10.334
AnalyticsPOST: Device Count for a Given Period and Areas
Allowable values/formatsDescriptionJSON array parameter
Time (in minutes) in the formnn-mm where nn is the lower limitand mm the upper limit. Themaximum upper limit is 1440minutes; which is 24 hours, or afull day. Accepted Values:
• 0-240
• 0-480
• 0-1440
• 5-240
• 5-480
• 5-1440
• 10-240
• 10-480
• 10-1440
• 15-240
• 15-480
• 15-1440
• 30-240
• 30-480
• 30-1440
• 45-240
• 45-480
• 45-1440
• 60-240
• 60-480
• 60-1440
Filter devices by dwell times forwhich device visits specified areas.If a device's dwell time fallsoutside of the range, it is filteredout and not considered a visit.
durationCategories
• true
• false
Whether to include stationarydevices (default=false)
includeStationary
• connected
• detected
• all
Whether to restrict to eitherconnected or detected devices(default=all)
connectionState
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 35
AnalyticsPOST: Device Count for a Given Period and Areas
Allowable values/formatsDescriptionJSON array parameter
Heterarchy levelIf set, does not report absolutenumbers, but relative percentage
percentageOf
• descendantOf
• subsetOf:comma separatedids
If set, restricts the results to areasmatching the filter. Use'descendantOf' to restrict the areaselection. This option is used fordrill down reports. Use 'subsetOf'to restrict the granularity. Thisoption is used with tag granularity.For example: descendantOf:Campus C1 has Building B1whichzone Z1 and Z2 Campus C2 hasBuilding B2 which zone Z3 queryarea=Z1,Z2,Z3 andgranularity=Building andareaFilter=descendantOf:C1 willreturn only Building B1
For example: subsetOf: Tag T1,T2assigned to F1, T2,T3 to F2, T3,T4to F3 query area=F1,F2,F3 andgranularity=tag andareaFilter=subsetOf:T1,T2 willreturn only T1,T2.
areaFilter
• true
• false
Include all of the elementsdescendants in the result
expandAll
HTTP Method
POST
Resource URI
/api/analytics/v1/deviceCount
Requires OAuth
N
Cisco Connected Mobile Experiences REST API Guide, Release 10.336
AnalyticsPOST: Device Count for a Given Period and Areas
Parameters
Table 14: Parameter Details
DescriptionLocationTypeDefaultRequiredName
JSON arraycontainingparameters
bodyJSON array—Ybody
Content Type
application/json
Sample Input (JSON){"period": "today","timeRange": "00:00-23:59","granularity": "Building","areas": "52,75,80"}
Sample Outpu (JSON){"startTime": "00:00","startDate": "2017-03-16","connectionState": "all","results": [{"id": -1,"ancestry": [],"series": [],"hasChildren": false,"level": "SUPERZONE","area": "Unknown area","data": []
}],"interval": null,"executionTime": 23,"minValue": 2147483647,"endDate": "2017-03-16","endTime": "23:59","dataFreshness": "2017-03-16T03:00:28.833-07:00","maxValue": 0
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 37
AnalyticsPOST: Device Count for a Given Period and Areas
GET: Repeat Device Status for One AreaDescription
Returns whether a device was seen as a repeat device in a particular area within the last 6 months.
HTTP Method
GET
Resource URI
/api/analytics/v1/isRepeatDevice/{deviceMac}/{areaId}
Requires OAuth
N
Parameters
Table 15: Parameter Details
DescriptionLocationTypeDefaultRequiredName
MAC address of device. For example,00:00:00:00:00:00
queryString—YdeviceMac
Global ID of heterarchy element. Forexample, 2654
queryString—YareaId
Content Type
application or json
Sample Response{ isRepeat : true }{ isRepeat : false }
Cisco Connected Mobile Experiences REST API Guide, Release 10.338
AnalyticsGET: Repeat Device Status for One Area
GET: Repeat Device Status for All AreasDescription
Returns whether a device was seen as a repeat device in any area within your heirarchy within the last 6months. .
HTTP Method
GET
Resource URI
/api/analytics/v1/isRepeatDevice/{deviceMac}
Requires OAuth
N
Parameters
Table 16: Parameter Details
DescriptionLocationTypeDefaultRequiredName
MAC address of device. For example,00:00:00:00:00:00
queryString—YdeviceMac
Content Type
application or json
Sample Response{ isRepeat : true }{ isRepeat : false }
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 39
AnalyticsGET: Repeat Device Status for All Areas
GET: Repeat Device Status for One AreaDescription
Returns detailed information of a repeat device within the last 6 months in a given area using theMAC addressof the device.
HTTP Method
GET
Resource URI
/api/analytics/v1/repeatDeviceStats/{deviceMac}/{areaId}
Requires OAuth
N
Parameters
Table 17: Parameter Details
DescriptionLocationTypeDefaultRequiredName
MAC address of device. For example,00:00:00:00:00:00
queryString—YdeviceMac
Global ID of heterarchy element. Forexample, 5540
queryString—YareaId
Content Type
application or json
Sample Response{"results": [{"id": 5540,"lastMonthSeen": "October","name": "SJC-23","userLevel": "Building","children": [{"id": 5498,"lastMonthSeen": "October","name": "2nd floor","userLevel": "Floor","daysSeenInLast30": [
]},{
Cisco Connected Mobile Experiences REST API Guide, Release 10.340
AnalyticsGET: Repeat Device Status for One Area
"id": 5539,"lastMonthSeen": "July","name": "3rd Floor","userLevel": "Floor","daysSeenInLast30": [
]}
],"daysSeenInLast30": [
]}
]}
Table 18: Response Description
The name of the latest month the device was seen ina particular area, with the search going as far back assix months
lastMonthSeen
The name of the area as seen in the heterarchy.name
The name of the heterarchy 'level' (i.e.Campus/Building/Floor/Zone)
userLevel
List of dates when the device was seen within the past30 days. If a device has been seen in the past 30 days,a more granular dataset showing all visits for thatdevice within those 30 days is stored in the locationtables
daysSeenInLast30
(if relevant) This is a recursive list of all child areaelements. Each item in this list contains the sameinformation as listed in the rows above and willcontain their own children arrays if the areas havechild elements.A sample heterarchy looks like this: 1 Campus -> 2Buildings -> 2 Floors each -> 2 Zones each will havechildren arrays of length 2 -> 2 -> 2 -> no childrenkey/value pair at the respective levels.
children
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 41
AnalyticsGET: Repeat Device Status for One Area
GET: Repeat Device Status In Any Area (Detailed)Description
Returns detailed information of a repeat device within the last 6 months in any area using the MAC addressof the device
HTTP Method
GET
Resource URI
/api/analytics/v1/repeatDeviceStats/{deviceMac}/{areaId}
Requires OAuth
N
Parameters
Table 19: Parameter Details
DescriptionLocationTypeDefaultRequiredName
MAC address of device. For example,00:00:00:00:00:00
queryString—YdeviceMac
Content Type
application or json
Sample Response{"results": [{"id": 4519,"lastMonthSeen": "October","name": "System Campus","userLevel": "Campus","children": [{"id": 5206,"lastMonthSeen": "July","name": "SJC-18","userLevel": "Building","children": [{"id": 5588,"lastMonthSeen": "July","name": "3rd Floor","userLevel": "Floor","daysSeenInLast30": [
]
Cisco Connected Mobile Experiences REST API Guide, Release 10.342
AnalyticsGET: Repeat Device Status In Any Area (Detailed)
}],"daysSeenInLast30": [
]},{"id": 5540,"lastMonthSeen": "October","name": "SJC-23","userLevel": "Building","children": [{"id": 5498,"lastMonthSeen": "October","name": "2nd floor","userLevel": "Floor","daysSeenInLast30": [
]},{"id": 5539,"lastMonthSeen": "July","name": "3rd Floor","userLevel": "Floor","daysSeenInLast30": [
]}
],"daysSeenInLast30": [
]},{"id": 5635,"lastMonthSeen": "October","name": "SJC-24","userLevel": "Building","children": [{"id": 5636,"lastMonthSeen": "October","name": "1st Floor","userLevel": "Floor","daysSeenInLast30": ["2016-10-04","2016-09-30","2016-09-27","2016-09-22"
]},{"id": 5637,"lastMonthSeen": "October","name": "2nd Floor","userLevel": "Floor","daysSeenInLast30": ["2016-10-04","2016-10-03","2016-09-22"
]},{"id": 5638,"lastMonthSeen": "October","name": "3rd Floor","userLevel": "Floor","daysSeenInLast30": ["2016-10-05","2016-10-04","2016-10-03",
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 43
AnalyticsGET: Repeat Device Status In Any Area (Detailed)
"2016-09-30","2016-09-27","2016-09-26","2016-09-23","2016-09-22"
]}
],"daysSeenInLast30": ["2016-10-05","2016-10-04","2016-10-03","2016-09-30","2016-09-27","2016-09-26","2016-09-23","2016-09-22"
]}
],"daysSeenInLast30": ["2016-10-05","2016-10-04","2016-10-03","2016-09-30","2016-09-27","2016-09-26","2016-09-23","2016-09-22"
]}
]}
Table 20: Response Description
DescriptionVariable
The name of the latest month the device was seen ina particular area, with the search going as far back assix months
lastMonthSeen
The name of the area as seen in the heterarchy.name
The name of the heterarchy 'level' (i.e.Campus/Building/Floor/Zone)
userLevel
List of dates when the device was seen within the past30 days. If a device has been seen in the past 30 days,a more granular dataset showing all visits for thatdevice within those 30 days is stored in the locationtables
daysSeenInLast30
(if relevant) This is a recursive list of all child areaelements. Each item in this list contains the sameinformation as listed in the rows above and willcontain their own children arrays if the areas havechild elements.A sample heterarchy looks like this: 1 Campus -> 2Buildings -> 2 Floors each -> 2 Zones each will havechildren arrays of length 2 -> 2 -> 2 -> no childrenkey/value pair at the respective levels.
children
Cisco Connected Mobile Experiences REST API Guide, Release 10.344
AnalyticsGET: Repeat Device Status In Any Area (Detailed)
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 45
AnalyticsGET: Repeat Device Status In Any Area (Detailed)
GET: Repeat Device Status for One Area (Abridged)Description
Returns abridged information of a repeat device within the last 6 months in a given area using the MACaddress of the device.
HTTP Method
GET
Resource URI
/api/analytics/v1/repeatDeviceStatsLite/{deviceMac}/{areaId}
Requires OAuth
N
Parameters
Table 21: Parameter Details
DescriptionLocationTypeDefaultRequiredName
MAC address of device. For example,00:00:00:00:00:00
queryString—YdeviceMac
Global ID of heterarchy element. Forexample, 5540
queryString—YareaId
Content Typeapplication or json
Sample Response{"results": [{"id": 2654,"lastMonthSeen": "October","name": "System Campus","userLevel": "Campus","daysSeenInLast30": ["2016-10-05","2016-10-04","2016-10-03","2016-09-30","2016-09-27","2016-09-26","2016-09-23","2016-09-22"
]}
Cisco Connected Mobile Experiences REST API Guide, Release 10.346
AnalyticsGET: Repeat Device Status for One Area (Abridged)
]}
Table 22: Response Description
DescriptionVariable
The name of the latest month the device was seen ina particular area, with the search going as far back assix months
lastMonthSeen
The name of the area as seen in the heterarchy.name
The name of the heterarchy 'level' (i.e.Campus/Building/Floor/Zone)
userLevel
List of dates when the device was seen within the past30 days. If a device has been seen in the past 30 days,a more granular dataset showing all visits for thatdevice within those 30 days is stored in the locationtables
daysSeenInLast30
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 47
AnalyticsGET: Repeat Device Status for One Area (Abridged)
GET: Repeat Device Status In Any Area (Abridged)Description
Returns abridged information of a repeat device within the last 6 months in any area using the MAC addressof the device
HTTP Method
GET
Resource URI
/api/analytics/v1/repeatDeviceStats/{deviceMac}/{areaId}
Requires OAuth
N
Parameters
Table 23: Parameter Details
DescriptionLocationTypeDefaultRequiredName
MAC address of device. For example,00:00:00:00:00:00
queryString—YdeviceMac
Content Type
application or json
Sample Response{"results": [{"id": 4519,"lastMonthSeen": "October","name": "System Campus","userLevel": "Campus","daysSeenInLast30": ["2016-10-05","2016-10-04","2016-10-03","2016-09-30","2016-09-27","2016-09-26","2016-09-23","2016-09-22"
]}
]}
Cisco Connected Mobile Experiences REST API Guide, Release 10.348
AnalyticsGET: Repeat Device Status In Any Area (Abridged)
Table 24: Response Description
DescriptionVariable
The name of the latest month the device was seen ina particular area, with the search going as far back assix months
lastMonthSeen
The name of the area as seen in the heterarchy.name
The name of the heterarchy 'level' (i.e.Campus/Building/Floor/Zone)
userLevel
List of dates when the device was seen within the past30 days. If a device has been seen in the past 30 days,a more granular dataset showing all visits for thatdevice within those 30 days is stored in the locationtables
daysSeenInLast30
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 49
AnalyticsGET: Repeat Device Status In Any Area (Abridged)
GET: Retrieve the count of active clients on a floor or multiplefloors right now.
Description
The only parameter (body) is a JSON array containing the parameters.
HTTP Method
GET
Resource URI
/api/analytics/v1/now/clientCount
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.350
AnalyticsGET: Retrieve the count of active clients on a floor or multiple floors right now.
POST: Retrieve the count of active clients on a floor or multiplefloors right now.
Description
The only parameter (body) is a JSON array containing the parameters.
Parameters
Table 25: Parameter Details
Allowablevalues/formats
DescriptionJSON arrayparameter
Acomma-separatedlist of floor ids.<floorId1>,<floorId2>,..
The list of floorsof interest. Ifnone are given,all areconsidered.
floors
• connected
• detected
• all
Whether torestrict to eitherconnected ordetected devices(default = all)
connectionState
HTTP Method
POST
Resource URI
/api/analytics/v1/now/clientCount
Requires OAuth
N
Parameters
Table 26: Parameter Details
DescriptionLocationTypeDefaultRequiredName
JSON arraycontainingparameters.
bodyJSON array—Ybody
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 51
AnalyticsPOST: Retrieve the count of active clients on a floor or multiple floors right now.
Content Type
application/json
Sample Input
{"floors": "17","connectionState": "all"}
Sample Output{"total": {"total": 0,"totalNumFloors": 0
},"connectionState": "all","failedFloorIds": [],"missingFloorIds": ["17"
],"executionTime": 1,"minValue": 2147483647,"data": [],"date": "2017-03-16","nonFloorIds": [],"maxValue": -2147483648
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.352
AnalyticsPOST: Retrieve the count of active clients on a floor or multiple floors right now.
POST: Retrieve the breakdown of connected and detecteddevices for a floor right now.
Description
The only parameter (body) is a JSON array containing the parameters.
HTTP Method
POST
Resource URI
/api/analytics/v1/now/connectedDetected
Requires OAuth
N
Parameters
Table 27: Parameter Details
DescriptionLocationTypeDefaultRequiredName
JSON arraycontainingparameters
bodyJSON arrayYbody
Content Type
application/json
Sample Input (JSON){"floors": "17"}
Sample Output (JSON){"total": {"totalDetected": 0,"totalNumFloors": 0,"totalAll": 0,"totalConnected": 0
},"startTime": "03:22","startDate": "2017-03-16","failedFloorIds": [],"missingFloorIds": ["17"
],
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 53
AnalyticsPOST: Retrieve the breakdown of connected and detected devices for a floor right now.
"results": [],"interval": null,"executionTime": 2,"endDate": "2017-03-16","endTime": "03:22","nonFloorIds": []
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.354
AnalyticsPOST: Retrieve the breakdown of connected and detected devices for a floor right now.
GET: Retrieve the breakdown of connected and detected devicesfor a floor right now.
Description
The only parameter (body) is a JSON array containing the parameters.
HTTP Method
GET
Resource URI
/api/analytics/v1/now/connectedDetected
Requires OAuth
N
Parameters
None.
Content Type
application/json
Sample Output{
"total":{"totalDetected":0,"totalNumFloors":1,"totalAll":0,"totalConnected":0
},"startTime":"10:37","startDate":"2017-06-19","failedFloorIds":[
],"missingFloorIds":[
],"results":[
{"ancestry":[
{"id":132,"level":"Building","name":"ACC"
},{
"id":133,"level":"Campus","name":"System Campus"
}],"id":131,"series":[
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 55
AnalyticsGET: Retrieve the breakdown of connected and detected devices for a floor right now.
"dwell"],"hasChildren":true,"area":"GF","data":[
{"dwell":"0-1440","values":{
"connected":0,"detected":0,"all":0
},"name":null
}]
}],"interval":null,"executionTime":211,"endDate":"2017-06-19","endTime":"10:37","nonFloorIds":[
]}
Cisco Connected Mobile Experiences REST API Guide, Release 10.356
AnalyticsGET: Retrieve the breakdown of connected and detected devices for a floor right now.
GET: Get Count of Clients in AreaDescription
This API gets list of clients for a given area.
HTTP Method
GET
Resource URI
/analytics/v1/now/clientCount/areas
Requires OAuth
N
Parameters
None
Content Type
application/json
Sample Output{
"invalidLevelIds":[
],"total":{
"total":0,"totalNumAreas":1
},"missingAreaIds":[
],"connectionState":"all","failedAreaIds":[
],"executionTime":47,"minValue":0,"data":[
{"areaName":"Campus","value":0,"areaId":1
}],"date":"2017-06-09","maxValue":0
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 57
AnalyticsGET: Get Count of Clients in Area
GET: Get Associated, Probing Count of Clients in AreaDescription
This API gets list of associated and/or probing client count for a given area.
HTTP Method
GET
Resource URI
/analytics/v1/now/connectedDetected/areas
Requires OAuth
N
Parameters
None
Content Type
application/json
Sample Output{
"total":{"totalDetected":0,"totalNumAreas":1,"totalAll":0,"totalConnected":0
},"startDate":"2017-06-09","interval":null,"executionTime":58,"endDate":"2017-06-09","endTime":"03:44","startTime":"03:44","invalidLevelIds":[
],"missingAreaIds":[
],"results":[
{"ancestry":[
],"id":1,"series":[
"dwell"],"hasChildren":true,"area":"Campus","data":[
{"dwell":"0-1440","values":{
Cisco Connected Mobile Experiences REST API Guide, Release 10.358
AnalyticsGET: Get Associated, Probing Count of Clients in Area
"connected":0,"detected":0,"all":0
},"name":null
}]
}],"failedAreaIds":[
],"maxValues":{
"connected":0,"detected":0
},"minValues":{
"connected":0,"detected":0
}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 59
AnalyticsGET: Get Associated, Probing Count of Clients in Area
Cisco Connected Mobile Experiences REST API Guide, Release 10.360
AnalyticsGET: Get Associated, Probing Count of Clients in Area
Configuration
• GET: Get Supported Northbound Notifications, page 64
• GET: Current CMX Image Version, page 65
• GET: Count of Active Alerts, page 66
• GET: All Alerts, page 67
• POST: Add Role to User, page 68
• DELETE: Role from User, page 69
• GET: All Users in the System, page 70
• POST: Create a User, page 71
• POST: Modify User, page 72
• GET: User by Username, page 73
• DELETE: User by Username, page 74
• GET: All Roles, page 75
• GET: All Campuses, page 76
• GET: Campus by Name, page 77
• PUT: Add Campus, page 78
• GET: Count of All Map Elements, page 79
• GET: List of all Building Names., page 80
• GET: List of all Building Names, page 81
• GET: List of all Floor Names, page 82
• GET: List of all Floor Names, page 83
• GET: All Maps, page 84
• GET: Campus by Name, page 85
• GET: Building by Name Inside Specific Campus, page 86
• GET: Floor Inside Specific Building and Specific Campus, page 87
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 61
• GET: Floor Image, page 88
• GET: Image by Name, page 89
• GET: All Sites, page 90
• GET: Site Details by ID or Name, page 91
• GET: System Settings, page 92
• PUT: System Settings, page 93
• GET: All Notification Subscriptions, page 94
• GET: Notifications by Name, page 95
• GET: Notification Subscription Availability, page 96
• PUT: Add Notification Subscription, page 97
• PUT: List of Notification Subscriptions, page 100
• DELETE: Notification Subscription, page 101
• GET: System Alert Subscription, page 102
• GET: Notifications by Name, page 103
• PUT: System Alert Subscription, page 104
• DELETE: Notification Alert Subscription, page 107
• POST: Change Status of Notification by Name, page 108
• GET: Unique Alerts by Time Interval, page 109
• GET: Alert by Time Interval, page 110
• GET: Alerts by Time Interval and Hashkey, page 111
• GET: Total Alerts Created for a Given Alert Key, page 112
• GET: All APs, page 113
• GET: Access Point by MAC Address, page 114
• GET: Settings for a Given User, page 115
• PUT: Setting for a Given User, page 116
• GET: All Cisco WLC Controllers, page 117
• GET: Get Cisco WLC Controllers by IP address, page 118
• PUT: Controller, page 119
• DELETE: All opt-out Devices, page 121
• GET: List of Opt-out Devices Within a Date Range, page 122
• GET: Count of opt-out Devices , page 123
• DELETE: Opt-out Devices Within a Date Range, page 124
• GET: List of Children Superzone IDs of a Hiterarchy Element, page 125
Cisco Connected Mobile Experiences REST API Guide, Release 10.362
Configuration
• GET: Children Superzone IDs of Hiterarchy Element, page 127
• GET: Gets the System Time, page 128
• DELETE: Removes all registered zones, page 129
• GET: Returns All Registered Zones , page 130
• POST: Add New Zone, page 132
• PUT: Add (Overwrite) New Zone, page 134
• GET:Get All Subscriptions, page 136
• POST: Add or Update Subscriptions, page 137
• DELETE: Delete All Subscriptions, page 138
• GET: Get Floors Managed by Controller, page 139
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 63
Configuration
GET: Get Supported Northbound NotificationsDescription
This API returns all supported notrhbound notification types and applicable attributes for the notificationrules.
HTTP Method
GET
Resource URI
/api/configuration/v1/attributes
Requires OAuth
N
Parameters
None.
Content Type
application/json
Sample Output{"networkdesignchanged":{"triggerHeterarchyChanged":{"name":"triggerHeterarchyChanged","dataType":"BOOLEAN","nameSpace":"networkdesignchanged","validValueSet":[],"needValueCheck":false,"evaluateByProvider":false},"triggerNetworkDesignChanged":{"name":"triggerNetworkDesignChanged","dataType":"BOOLEAN","nameSpace":"networkdesignchanged","validValueSet":[],"needValueCheck":false,"evaluateByProvider":false}},"servicestatus":{"oldStatus":{"name":"oldStatus","dataType":"ENUM","nameSpace":"servicestatus","validValueSet":["STOPPED","RUNNING","CRASHED","DISABLED"],"needValueCheck":false,"evaluateByProvider":false},"status":{"name":"status","dataType":"ENUM","nameSpace":"servicestatus","validValueSet":["STOPPED","RUNNING","CRASHED","DISABLED"],"needValueCheck":true,"evaluateByProvider":true},"statusChanged":{"name":"statusChanged","dataType":"BOOLEAN","nameSpace":"servicestatus","validValueSet":[],"needValueCheck":true,"evaluateByProvider":false}}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.364
ConfigurationGET: Get Supported Northbound Notifications
GET: Current CMX Image VersionDescription
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.3 65
ConfigurationGET: Current CMX Image Version
GET: Count of Active AlertsDescription
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.366
ConfigurationGET: Count of Active Alerts
GET: All AlertsDescription
This API returns all active alerts.
HTTP Method
GET
Resource URI
/api/config/v1/alerts
Requires OAuth
N
Parameters
None.
Content Type
application/json
Sample Output (JSON)[{"changedOn": 1490159411911,"tenantId": 0,"lastNotificationTime": 1490159411918,"hashkey": -1446685026,"alertType": "NMSP_CONNECTION_STATUS","alertStatus": "Unhandled","severity": "Critical","origin": "cmx-vmdev83 WLC: 10.32.168.50","source": "NMSPLB","alarmDescription": "NMSP connection status is inactive for WLC 10.32.168.50","lastEmail": 0,"refId": "NMSPLB"
}]
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 67
ConfigurationGET: All Alerts
POST: Add Role to UserDescription
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 28: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Username of the user.pathReplaceString—Yusername
Role name to be added to theuser.
pathReplaceString—Yrolename
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.368
ConfigurationPOST: Add Role to User
DELETE: Role from UserDescription
Remove role from a user.
HTTP Method
DELETE
Resource URI
/api/config/v1/aaa/users/:username/role/:rolename
Requires OAuth
N
Parameters
Table 29: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Username of user.pathReplaceString—Yusername
Role name that needs tobe deleted from thisuser.
pathReplaceString—Yrolename
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 69
ConfigurationDELETE: Role from User
GET: All Users in the SystemDescription
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.370
ConfigurationGET: All Users in the System
POST: Create a UserDescription
This API enables you to create a user.
HTTP Method
POST
Resource URI
/api/config/v1/aaa/users
Requires OAuth
N
Parameters
Table 30: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Username of the user.bodystring—Y___username
Password of the user.bodystring—Ypassword
First name of the user.bodystring—Nfirstname
Last name of the user.bodystring—Nlastname
Roles for this user.bodytext—Nroles
CMX API DeveloperKey.
bodystring—Ndeveloperkey
User's last login.bodytext—Nlastlogin
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 71
ConfigurationPOST: Create a User
POST: Modify UserDescription
This API modifies the attributes of a user.
HTTP Method
POST
Resource URI
/api/config/v1/aaa/users/:username
Requires OAuth
N
Parameters
Table 31: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Username name of theuser
pathReplaceString—Yusername
Username of the user.bodystring—Y___username
Password of the user.bodystring—Ypassword
First name of the user.bodystring—Nfirstname
Last name of the user.bodystring—Nlastname
Roles assigned to thisuser.
bodytext—Nroles
CMX API DeveloperKey.
bodystring—Ndeveloperkey
User's Last Login.bodytext—Nlastlogin
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.372
ConfigurationPOST: Modify User
GET: User by UsernameDescription
This API retrives user by username.
HTTP Method
GET
Resource URI
/api/config/v1/aaa/users/:username
Requires OAuth
N
Parameters
Table 32: Parameter Details
DescriptionLocationTypeDefaultRequiredName
UsernamepathReplaceString—Yusername
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 73
ConfigurationGET: User by Username
DELETE: User by UsernameDescription
This API deletes a user.
HTTP Method
DELETE
Resource URI
/api/config/v1/aaa/users/:username
Requires OAuth
N
Parameters
Table 33: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Username.pathReplaceString—Yusername
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.374
ConfigurationDELETE: User by Username
GET: All RolesDescription
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.3 75
ConfigurationGET: All Roles
GET: All CampusesDescription
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.376
ConfigurationGET: All Campuses
GET: Campus by NameDescription
This API returns a campus by name.
HTTP Method
GET
Resource URI
/api/config/v1/campuses/:name
Requires OAuth
N
Parameters
Table 34: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Campus Name .pathReplaceString—Yname
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 77
ConfigurationGET: Campus by Name
PUT: Add CampusDescription
This API enables you to add a campus.
HTTP Method
PUT
Resource URI
/api/config/v1/campuses
Requires OAuth
N
Parameters
Table 35: Parameter Details
DescriptionLocationTypeDefaultRequiredName
objectVersionbodynumber—NobjectVersion
Name of the campus.This value should beunique.
bodystring—Yname
Dimensionbodytext—Ndimension
imagebodytext—Nimage
List of buildings insidethe campus.
bodytext—NbuildingList
aesUidbodynumber—NaesUid
aesUidStringbodystring—NaesUidString
membersbodytext—Nmembers
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.378
ConfigurationPUT: Add Campus
GET: Count of All Map ElementsDescription
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.3 79
ConfigurationGET: Count of All Map Elements
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 36: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Campus NamepathReplaceString—Yname
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.380
ConfigurationGET: List of all Building Names.
GET: List of all Building NamesDescription
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.3 81
ConfigurationGET: List of all Building Names
GET: List of all Floor NamesDescription
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 37: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Building NamepathReplaceString—Yname
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.382
ConfigurationGET: List of all Floor Names
GET: List of all Floor NamesDescription
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.3 83
ConfigurationGET: List of all Floor Names
GET: All MapsDescription
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.384
ConfigurationGET: All Maps
GET: Campus by NameDescription
This API returns a campus by name.
HTTP Method
GET
Resource URI
/api/config/v1/maps/info/:campusName
Requires OAuth
N
Parameters
Table 38: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Campus NamepathReplaceString—YcampusName
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 85
ConfigurationGET: Campus by Name
GET: Building by Name Inside Specific CampusDescription
This API returns a building by name.
HTTP Method
GET
Resource URI
/api/config/v1/maps/info/:campusName/:buildingName
Requires OAuth
N
Parameters
Table 39: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Campus Name.pathReplaceString—YcampusName
Building Name.pathReplaceString—YbuildingName
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.386
ConfigurationGET: Building by Name Inside Specific Campus
GET: Floor Inside Specific Building and Specific CampusDescription
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 40: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Campus Name.pathReplaceString—YcampusName
Building Name.pathReplaceString—YbuildingName
Floor Name.pathReplaceString—YfloorName
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 87
ConfigurationGET: Floor Inside Specific Building and Specific Campus
GET: Floor ImageDescription
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 41: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Campus Name.pathReplaceString—YcampusName
Building Name.pathReplaceString—YbuildingName
Floor Name.pathReplaceString—YfloorName
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.388
ConfigurationGET: Floor Image
GET: Image by NameDescription
This API returns an image by image name.
HTTP Method
GET
Resource URI
/api/config/v1/maps/imagesource/:imageName
Requires OAuth
N
Parameters
Table 42: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Image Name.pathReplaceString—YimageName
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 89
ConfigurationGET: Image by Name
GET: All SitesDescription
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
Example[{"changedOn":0,"aesUId":1487056035936,"name":"PSLNOC","description":null,"aps":[],"rssiThresholdLow":-95,"rssiThresholdHigh":-65,"examinePeriod":900000,"minDuration":300000,"tags":null,"apCount":3,"timezone":"Asia/Kolkata","aesUidString":"1487056035936","tagList":null,"address":"Nagpur","latitude":0.0,"longitude":0.0,"applyExclusion":false,"exclusionParams":null,"currentTime":"Feb28, 2017 3:37:50PM","objectVersion":0},{"changedOn":0,"aesUId":1487260407843,"name":"NOC","description":null,"aps":[],"rssiThresholdLow":-95,"rssiThresholdHigh":-65,"examinePeriod":900000,"minDuration":300000,"tags":null,"apCount":1,"timezone":"Asia/Kolkata","aesUidString":"1487260407843","tagList":null,"address":"Nagpur","latitude":0.0,"longitude":0.0,"applyExclusion":false,"exclusionParams":null,"currentTime":"Feb28, 2017 3:37:50 PM","objectVersion":0}]
Cisco Connected Mobile Experiences REST API Guide, Release 10.390
ConfigurationGET: All Sites
GET: Site Details by ID or NameDescription
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.3 91
ConfigurationGET: Site Details by ID or Name
GET: System SettingsDescription
This API retrives system settings.
HTTP Method
GET
Resource URI
/api/config/v1/system/preferences/:component/:key
Requires OAuth
N
Parameters
Table 43: Parameter Details
DescriptionLocationTypeDefaultRequiredName
The component.pathReplaceString—Ycomponent
The key to retrieve. Ifnot set, retrieves all keysfor the givencomponent.
pathReplaceString—Nkey
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.392
ConfigurationGET: System Settings
PUT: System SettingsDescription
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 44: Parameter Details
DescriptionLocationTypeDefaultRequiredName
The component.pathReplaceString—Ycomponent
The key.pathReplaceString—Ykey
Value.bodystring—YString
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 93
ConfigurationPUT: System Settings
GET: All Notification SubscriptionsDescription
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.394
ConfigurationGET: All Notification Subscriptions
GET: Notifications by NameDescription
This API returns a notification subscription by name.
HTTP Method
GET
Resource URI
/api/config/v1/notifications/:name
Requires OAuth
N
Parameters
Table 45: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Notification Name.pathReplaceString—Yname
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 95
ConfigurationGET: Notifications by Name
GET: Notification Subscription AvailabilityDescription
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 46: Parameter Details
DescriptionLocationTypeDefaultRequiredName
NotificationName.pathReplaceString—Yname
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.396
ConfigurationGET: Notification Subscription Availability
PUT: Add Notification SubscriptionDescription
This API allows you to add a notification subscription.
HTTP Method
PUT
Resource URI
/api/config/v1/notification
Requires OAuth
N
Parameters
Table 47: Parameter Details
DescriptionLocationTypeDefaultRequiredName
User ID.bodystring—YuserId
List of rules.bodytext—Yrules
Subscribersbodytext—Ysubscribers
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 97
ConfigurationPUT: Add Notification Subscription
DescriptionLocationTypeDefaultRequiredName
Choose one of the followingnotification 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
bodyenumerated—YnotificationType
enabled
• true
• false
bodyenumerated—Nenabled
Cisco Connected Mobile Experiences REST API Guide, Release 10.398
ConfigurationPUT: Add Notification Subscription
DescriptionLocationTypeDefaultRequiredName
enableMacScrambling
• true
• false
bodyenumerated—NenableMacScrambling
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 99
ConfigurationPUT: Add Notification Subscription
PUT: List of Notification SubscriptionsDescription
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.3100
ConfigurationPUT: List of Notification Subscriptions
DELETE: Notification SubscriptionDescription
This API allows to delete a notification subscription.
HTTP Method
DELETE
Resource URI
/api/config/v1/notifications/:name
Requires OAuth
N
Parameters
Table 48: Parameter Details
DescriptionLocationTypeDefaultRequiredName
NotificationName.
pathReplaceString—Yname
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 101
ConfigurationDELETE: Notification Subscription
GET: System Alert SubscriptionDescription
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.3102
ConfigurationGET: System Alert Subscription
GET: Notifications by NameDescription
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 49: Parameter Details
DescriptionLocationTypeDefaultRequiredName
NotificationName.
pathReplaceString—Yname
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 103
ConfigurationGET: Notifications by Name
PUT: System Alert SubscriptionDescription
This API allows to add system alert subscription.
HTTP Method
PUT
Resource URI
/api/config/v1/notifications/alert
Requires OAuth
N
Parameters
Table 50: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Choose one of the followingseverity levels:
• Critical
• Major
• Minor
•Warning
• Info
• Cleared
bodyenumerated—Yseverity
User ID.bodystring—YuserId
List of rules.bodytext—Yrules
Subscribersbodytext—Ysubscribers
Cisco Connected Mobile Experiences REST API Guide, Release 10.3104
ConfigurationPUT: System Alert Subscription
DescriptionLocationTypeDefaultRequiredName
Choose one of the followingnotification 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
bodyenumerated—YnotificationType
enabled
• true
• false
bodyenumerated—Nenabled
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 105
ConfigurationPUT: System Alert Subscription
DescriptionLocationTypeDefaultRequiredName
enableMacScrambling
• true
• false
bodyenumerated—NenableMacScrambling
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3106
ConfigurationPUT: System Alert Subscription
DELETE: Notification Alert SubscriptionDescription
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 51: Parameter Details
DescriptionLocationTypeDefaultRequiredName
NotificationName.
pathReplaceString—Yname
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 107
ConfigurationDELETE: Notification Alert Subscription
POST: Change Status of Notification by NameDescription
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 52: Parameter Details
DescriptionLocationTypeDefaultRequiredName
NotificationName.
pathReplaceString—Yname
Enable/DisablepathReplaceString—Yaction
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3108
ConfigurationPOST: Change Status of Notification by Name
GET: Unique Alerts by Time IntervalDescription
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 53: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Specifies the start time inmilliseconds.
queryNumber—YstartTime
Specifies the end time inmilliseconds.
queryNumber—YendTime
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 109
ConfigurationGET: Unique Alerts by Time Interval
GET: Alert by Time IntervalDescription
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 54: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Specifies the start timein milliseconds.
queryNumber—YstartTime
Specifies the end timein milliseconds.
queryNumber—YendTime
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3110
ConfigurationGET: Alert by Time Interval
GET: Alerts by Time Interval and HashkeyDescription
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 55: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Alert Hashkey which could beobtained by calling /config/v1/alerts.
pathReplaceString—Ykey
Specifies the start time inmilliseconds.
queryNumber—YstartTime
Specifies the end time inmilliseconds.
queryNumber—YendTime
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 111
ConfigurationGET: Alerts by Time Interval and Hashkey
GET: Total Alerts Created for a Given Alert KeyDescription
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 56: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Alert Hashkey which could be obtainedby calling /config/v1/alerts.
pathReplaceString—Ykey
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3112
ConfigurationGET: Total Alerts Created for a Given Alert Key
GET: All APsDescription
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.3 113
ConfigurationGET: All APs
GET: Access Point by MAC AddressDescription
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 57: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Access pointMAC address.
pathReplaceString—Ymac
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3114
ConfigurationGET: Access Point by MAC Address
GET: Settings for a Given UserDescription
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 58: Parameter Details
DescriptionLocationTypeDefaultRequiredName
The user ID.pathReplaceString—Yuserid
The component.pathReplaceString—Ycomponent
The key to retrieve. If notset, retrieves all keys forthe given component.
pathReplaceString—Nkey
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 115
ConfigurationGET: Settings for a Given User
PUT: Setting for a Given UserDescription
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 59: Parameter Details
DescriptionLocationTypeDefaultRequiredName
The user ID.pathReplaceString—Yuserid
The component.pathReplaceString—Ycomponent
The key.pathReplaceString—Ykey
Whether the data passed isJSON - if set, this will validatethe data and reject malformedJSONAllowed values/formats:true or false.
queryString—Njson
Valuebodystring—YString
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3116
ConfigurationPUT: Setting for a Given User
GET: All Cisco WLC ControllersDescription
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.3 117
ConfigurationGET: All Cisco WLC Controllers
GET: Get Cisco WLC Controllers by IP addressDescription
This API returns a controller given an IP address.
HTTP Method
GET
Resource URI
/api/config/v1/controllers/:ipAddress
Requires OAuth
N
Parameters
Table 60: Parameter Details
DescriptionLocationTypeDefaultRequiredName
IP Address.pathReplaceString—YipAddress
Content Type
application/json
Sample Output
http://10.68.40.131/api/config/v1/controllers/10.68.40.124{"name":null,"ipAddress":"10.68.40.124","readOnlyComm":null,"writeComm":"iuBXuWikK4nfq52YKODcUg==","snmpVersion":1,"version":"8.1.131","userName":"admin","authType":0,"authPassword":null,"privType":0,"privPassword":null,"macAddress":null,"sysUpTime":0,"unauthenticatedConnection":false,"applicableServices":[0],"aesUId":1448982516930,"objectVersion":0,"tagNotificationInterval":0,"wlanConfigList":[],"deviceVersion":null,"type":"WLC","enablePassword":null,"peerMode":false,"members":null}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3118
ConfigurationGET: Get Cisco WLC Controllers by IP address
PUT: ControllerDescription
This API allows you to add a controller.
HTTP Method
PUT
Resource URI
/api/config/v1/controllers
Requires OAuth
N
Parameters
Table 61: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Name of the Wireless LANcontroller.
bodystring—Yname
IP address of theWireless LANcontroller.
bodystring—YipAddress
SNMP Read Community.bodystring—YreadOnlyComm
SNMP Write Community.bodystring—YwriteComm
SNMP Version.bodynumber—NsnmpVersion
Software version of the WLCController.
bodystring—Yversion
User name for the telnetconnection.
bodystring—YuserName
SNMP v3 Auth Type.bodynumber—YauthType
Authentication Password.bodystring—NauthPassword
Privacy Type.bodynumber—NprivType
Password.bodystring—NprivPassword
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 119
ConfigurationPUT: Controller
DescriptionLocationTypeDefaultRequiredName
MAC Address.bodystring—NmacAddress
System Up time.bodynumber—NsysUpTime
Authentication to connect to theWLC Controller.
• true
• false
bodyenumerated—NunauthenticatedConnection
Services to subscribe to thecontroller.
bodyarray—YapplicableServices
Cisco Prime Infrastructuregenerated unique ID. If notgenerated by Cisco PrimeInfrastructure, please use aunique value.
bodynumber—YaesUId
Object version.bodynumber—NobjectVersion
Tag notification interval.bodynumber—NtagNotificationInterval
WLCController Configurationlist.
bodytext—NwlanConfigList
Version of the device.bodystring—NdeviceVersion
type
•WLC
• NGWC
bodyenumerated—Ntype
enablePasswordbodystring—NenablePassword
peerMode
• true
• false
bodyenumerated—NpeerMode
Members.bodytext—Nmembers
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3120
ConfigurationPUT: Controller
DELETE: All opt-out DevicesDescription
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.3 121
ConfigurationDELETE: All opt-out Devices
GET: List of Opt-out Devices Within a Date RangeDescription
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 62: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Start date of range Allowed values/formats:yyyy-mm-dd hh:mm:ss
queryString—NvalidFrom
End date of range Allowed values/formats:yyyy-mm-dd hh:mm:ss
queryString—NvalidTo
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3122
ConfigurationGET: List of Opt-out Devices Within a Date Range
GET: Count of opt-out DevicesDescription
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
Sample Output
{"Opt-out Device count":0}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 123
ConfigurationGET: Count of opt-out Devices
DELETE: Opt-out Devices Within a Date RangeDescription
This API deletes opt-out devices.
HTTP Method
DELETE
Resource URI
/api/configuration/v1/optout/devices/date
Requires OAuth
N
Parameters
Table 63: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Start date of range Allowedvalues/formats: yyyy-mm-ddhh:mm:ss.
queryString—NvalidFrom
End date of range Allowedvalues/formats: yyyy-mm-ddhh:mm:ss.
queryString—NvalidTo
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3124
ConfigurationDELETE: Opt-out Devices Within a Date Range
GET: List of Children Superzone IDs of a Hiterarchy ElementDescription
The call retrieves children superzone IDs of a heterarchy element and, under them, the AES IDs of the nestedchildren floors. 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).
HTTP Method
GET
Resource URI
/api/config/v1/heterarchy/:pathSegments/childrenfloors
Requires OAuth
N
Parameters
Table 64: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Full path to theelement orelement id.
pathReplaceString—NpathSegments
Show elementsvalid at givendate(yyyy-mm-ddHH:mm:ss)Allowedvalues/formats:yyyy-mm-ddHH:mm:ss.
queryString—NvalidDate
Level name(SUPERZONE,FLOOR, AP,POI, or ZONE)Allowedvalues/formats:SUPERZONEFLOOR APZONE POI.
queryString—Nlevel
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 125
ConfigurationGET: List of Children Superzone IDs of a Hiterarchy Element
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3126
ConfigurationGET: List of Children Superzone IDs of a Hiterarchy Element
GET: Children Superzone IDs of Hiterarchy ElementDescription
The call retrieves children superzone IDs of an heterarchy element and, under them, the counts of all thenested children elements. The element is identified by the path of the API call (either the full path or the IDof the element- see Add/Update zones or tags for details on obtaining the element id). Specifying a levelretrieves only children of that level.
HTTP Method
GET
Resource URI
/api/config/v1/heterarchy/:pathSegments/childrencounts
Requires OAuth
N
Parameters
Table 65: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Full path to the element or element ID.pathReplaceString—NpathSegments
Show elements valid from given date(yyyy-mm-dd HH:mm:ss) Allowedvalues/formats: yyyy-mm-dd HH:mm:ss.
queryString—NvalidDate
Level name (SUPERZONE, FLOOR, AP,POI, or ZONE) Allowed values/formats:SUPERZONE FLOOR AP ZONE POI.
queryString—Nlevel
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 127
ConfigurationGET: Children Superzone IDs of Hiterarchy Element
GET: Gets the System TimeDescription
HTTP Method
GET
Resource URI
/api/config/v1/system/time
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3128
ConfigurationGET: Gets the System Time
DELETE: Removes all registered zonesDescription
This API removes all registered zones.
HTTP Method
DELETE
Resource URI
/api/config/v1/zoneCountParams/:clusterId
Requires OAuth
N
Parameters
Table 66: Parameter Details
DescriptionLocationTypeDefaultRequiredName
clusterId(default 1)
pathReplaceString1YclusterId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 129
ConfigurationDELETE: Removes all registered zones
GET: Returns All Registered ZonesDescription
This API returns details of all registered zones.
HTTP Method
GET
Resource URI
/api/config/v1/zoneCountParams/:clusterId
Requires OAuth
N
Parameters
Table 67: Parameter Details
DescriptionLocationTypeDefaultRequiredName
clusterId(default 1)
pathReplaceNumber1YclusterId
Content Type
application/json
Usage Guidelineshttp://<cmx-ip-address>/api/config/v1/zoneCountParams/<cluster-id>For Example:http://10.0.0.1/api/config/v1/zoneCountParams/1
Sample Output{name: "ZoneCountParams",zoneHierarchy: ["Simulator-2201-Campus0/Building2/Floor2/Zone2","Simulator-2201-Campus0/Building4/Floor4/Zone4","Simulator-2201-Campus0/Building7/Floor2/Zone3"],zoneIds: [ ],zoneDetails: [{id: 65811,hierarchy: "Simulator-2201-Campus0/Building2/Floor2/Zone2",name: "Zone2",active: true},{
Cisco Connected Mobile Experiences REST API Guide, Release 10.3130
ConfigurationGET: Returns All Registered Zones
id: 66475,hierarchy: "Simulator-2201-Campus0/Building4/Floor4/Zone4",name: "Zone4",active: true},{id: 67192,hierarchy: "Simulator-2201-Campus0/Building7/Floor2/Zone3",name: "Zone3",active: true}],totalZones: 3,debug: false}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 131
ConfigurationGET: Returns All Registered Zones
POST: Add New ZoneDescription
This API adds a zone to the existing list of zones. For all hierarchies, system tries to find them in the heterarchyand if the match is successful we have an ID for every zone specified. When the zone is not found, we dropthat zone from the configuration.
HTTP Method
POST
Resource URI
/api/config/v1/zoneCountParams/:clusterId
Requires OAuth
N
Parameters
Table 68: Parameter Details
DescriptionLocationTypeDefaultRequiredName
clusterId (default 1)pathReplaceString1YclusterId
List of exact zone hierarchy separatedby /, i.e. Campus/Building/Floor/Zone.(including spaces, if any of the campus/ building /floor /zone has spaces in thename) Ensure zones hierarchy are nestedwithin the square brackets [ ] to beconsidered as list, otherwise thisoperation would fail For specifyingsingle zone,["Campus/Building/Floor/Zone1"] Forspecifying multiple zones,["Campus/Building/Floor/Zone1","Campus/Building/Floor/Zone2"]
bodyarrayYzoneHierarchy
List of zoneids,
Ensure zoneIds are nested within thesquare brackets [ ] to be considered aslist, otherwise this operation would failfor e.g. single zone as [391] multiplezones as [391,392]
bodyarrayNzoneIds
Cisco Connected Mobile Experiences REST API Guide, Release 10.3132
ConfigurationPOST: Add New Zone
DescriptionLocationTypeDefaultRequiredName
Populated by API after parsingzoneHierarchy or zoneIds input
bodytextNzoneDetails
Total registered zones, Populated by APIafter parsing zoneHierarchy or zoneIdsinput
bodynumberNtotalZones
debug flag to enable recordingmacaddresses for registered zones
• true
• false
bodyenumeratedfalseNdebug
Content Type
application/json
Sample Input (JSON){"name": "ZoneCountParams","zoneHierarchy": ["Nortech Campus/Nortech Building/Security Floor/zone1","Nortech Campus/Nortech Building/Security Floor/zone2","System Campus/SJC-24/3rd Floor/Zone_2","System Campus/SJC-24/3rd Floor/Zone_1"]}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 133
ConfigurationPOST: Add New Zone
PUT: Add (Overwrite) New ZoneDescription
This API is similar to the POST: Add New Zone API, but replaces rather than appends the new zone(s) to theresigtered zone(s) list.
HTTP Method
PUT
Resource URI
/api/config/v1/zoneCountParams/:clusterId
Requires OAuth
N
Parameters
Table 69: Parameter Details
DescriptionLocationTypeDefaultRequiredName
clusterId (default 1)pathReplaceString1YclusterId
List of exact zone hierarchyseparated by /, i.e.Campus/Building/Floor/Zone.(including spaces, if any of thecampus / building /floor /zone hasspaces in the name)</p> Ensurezones hierarchy are nested withinthe square brackets [ ] to beconsidered as list, otherwise thisoperation would fail</p> Forspecifying single zone,["Campus/Building/Floor/Zone1"]</p>For specifying multiple zones,["Campus/Building/Floor/Zone1","Campus/Building/Floor/Zone2"]</p>
bodyarrayYzoneHierarchy
List of zoneids
Ensure zoneIds are nested withinthe square brackets [ ] to beconsidered as list, otherwise thisoperation would failfor e.g. single zone as [391]multiple zones as [391,392]
bodyarrayNzoneIds
Cisco Connected Mobile Experiences REST API Guide, Release 10.3134
ConfigurationPUT: Add (Overwrite) New Zone
DescriptionLocationTypeDefaultRequiredName
Populated by API after parsingzoneHierarchy or zoneIds input
bodytextNzoneDetails
Total registered zones, Populatedby API after parsingzoneHierarchy or zoneIds input
bodynumberNtotalZones
debug flag to enable recordingmacaddresses for registered zones
• true
• false
bodyenumeratedfalseNdebug
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 135
ConfigurationPUT: Add (Overwrite) New Zone
GET:Get All SubscriptionsDescription
This API returns all subscriptions.
HTTP Method
GET
Resource URI
/config/v1/partnerStreamNotification
Requires OAuth
N
Parameters
None
Content Type
application/json
Sample Output{"name": null,"subs": {"abc2": {"name": "abc2","host": "127.0.0.1","port": 8001,"enabled": false
}},"lastActedSubs": [{"name": "abc2","host": "127.0.0.1","port": 8001,"enabled": false
}]
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3136
ConfigurationGET:Get All Subscriptions
POST: Add or Update SubscriptionsDescription
This API adds new or updates existing subscriptions. Subscriptions can not share a name. Their destinations(host+port combination) must be unique. You can have a maximum of five subscriptions (including disabledsubscriptions).
HTTP Method
POST
Resource URI
/api/config/v1/partnerStreamNotification
Requires OAuth
N
Content Type
application/json
Sample Input{"name":"abc2","host":"127.0.0.1","port":8001,"enabled":false}
Sample Output
Output is successful if the response code is 200.
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 137
ConfigurationPOST: Add or Update Subscriptions
DELETE: Delete All SubscriptionsDescription
This API deletes a subscription.
HTTP Method
DELETE
Resource URI
/api/config/v1/partnerStreamNotification
Requires OAuth
N
Parameters
None
Content Type
application/json
Sample Input{"name":"abc2"}
Sample Output
Output is successful if the response code is 200.
Cisco Connected Mobile Experiences REST API Guide, Release 10.3138
ConfigurationDELETE: Delete All Subscriptions
GET: Get Floors Managed by ControllerDescription
This API gets a list of floors managed by Cisco WLC Controller.
HTTP Method
GET
Resource URI
/config/v1/controllers/:ipAddress/floor
Requires OAuth
N
Parameters
None
Content Type
application/json
Sample Output
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 139
ConfigurationGET: Get Floors Managed by Controller
Cisco Connected Mobile Experiences REST API Guide, Release 10.3140
ConfigurationGET: Get Floors Managed by Controller
Connect
• GET: Query User Sessions, page 142
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 141
GET: Query User SessionsDescription
Query user session data based on the filter criteria. The results are sorted by last login time in descendingorder. The search can be performed on MAC addresses, last session time, status, and any or all fields. Thequery is paged using index and count parameters with maximum size in 1000. The returned JSON objectincludes the number of records returned and next index to query if more. You can also download the queriedresult in CSV file with URL /api/connect/v1/clients/export. The export query does not have maximum sizelimit.
HTTP Method
GET
Resource URI
/api/connect/v1/clients
Requires OAuth
N
Parameters
Table 70: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Session start time based on last logintime in UTC format.
queryString—Nstart
Session end time based on last logintime in UTC format.
queryString—Nend
Starting index of the query based on0.
queryString—Nindex
Number of records to query with thelimit of 1000 at maximum.
queryString—Ncount
Status of the users. Allowed:all,active.
queryString—Nstatus
Authentication type used by theuser. Allowedvalues/formats:registration, SMS,social.
queryString—Nauthtype
Cisco Connected Mobile Experiences REST API Guide, Release 10.3142
ConnectGET: Query User Sessions
DescriptionLocationTypeDefaultRequiredName
MAC address in00:11:22:33:44:55:66 format. IfMAC address is used, all otherparameters will be ignored.
queryString—Nmac
Type of user's device.queryString—Ndevice
Operating system of user's device.queryString—Nos
Language served to the user. It cansearch by full language name ortwo-letter language code.
queryString—Nlanguage
The search applies to all fields.queryString—Nall
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 143
ConnectGET: Query User Sessions
Cisco Connected Mobile Experiences REST API Guide, Release 10.3144
ConnectGET: Query User Sessions
Location
• GET: Active RFID Tags Count, page 147
• GET: All Tags, page 148
• GET: RFID Tag by MAC Address, page 149
• GET: Supported Northbound Notifications, page 150
• GET: Count of all the Beacons, page 152
• PUT: Place a Beacon at Detected Location on Map, page 153
• PUT: Updates Name of a Given Beacon, page 154
• GET: List of Beacons Matching Filter Criteria, page 155
• POST: Add Beacon with Minimum Fields, page 156
• GET: Beacons with Minimum Information for a Floor ID, page 157
• GET: List of Beacons, page 158
• GET: Beacon by MAC Address, page 159
• DELETE: Delete Beacon by MAC Address, page 160
• PUT: Update Beacon, page 161
• GET: List of Beacons Present on a Floor, page 163
• POST: Add Beacon to the Store, page 165
• GET: Active Clients Count, page 167
• GET: All clients, page 169
• GET: Collection of Active Clients MAC Address, page 170
• GET: Compact History of Client by Date and Username, page 171
• GET: Unique MAC Address Seen on a Given Day on a Floor or Zone, page 173
• GET: Compact History of Client By Date and IPv4 Address, page 175
• GET: This API returns history for all clients, page 177
• GET: History of Client by MAC Address, page 179
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 145
• GET: Get all configuration compliance rules for client troubleshooting, page 180
• GET: Get all configuration compliance rules for client troubleshooting from MAC, page 181
• POST: Execute a compliance rule for troubleshooting, page 182
• GET: Get interferer by macaddress, page 184
• GET: Get total number of interferers, page 185
• GET: Get all interferers, page 186
• GET: This API returns all RFID tags with minimal information, page 187
• GET: Returns active clients count and mac addresses for each registered zone, page 188
• GET: Returns active clients count for each registered zone, page 191
• GET : Get Active APs, page 193
• GET: Get Count of Active APs, page 194
• GET: Get List of Missing APs, page 195
• GET: Get Count of Missing APs, page 196
Cisco Connected Mobile Experiences REST API Guide, Release 10.3146
Location
GET: Active RFID Tags CountDescription
This API returns active RFID tags count.
HTTP Method
GET
Resource URI
/api/location/v1/tags/count
Requires OAuth
N
Parameters
None.
Content Type
application/json
Sample Output
{"deviceType":"Tag","deviceQueryString":null,"count":8}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 147
LocationGET: Active RFID Tags Count
GET: All TagsDescription
This API returns all tags.
HTTP Method
GET
Resource URI
/api/location/v1/tags
Requires OAuth
N
Parameters
None.
Content Type
application/json
Sample Output[{"macAddress":"00:18:8e:28:24:26","mapInfo":{"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId":"739764660256899136","floorDimension":{"length":118.11024,"width":184.05511,"height":9.84252,"offsetX":0.0,"offsetY":0.0,"unit":"FEET"},"image":{"imageName":"domain_0_1380690706964.png","zoomLevel":4,"width":1440.0,"height":900.0,"size":1440.0,"maxResolution":8.0,"colorDepth":8}},"mapCoordinate":{"x":108.84515,"y":68.62626,"z":0.0,"unit":"FEET"},"currentlyTracked":true,"confidenceFactor":72.0,"statistics":{"currentServerTime":"2016-06-16T02:17:38.682+0800","firstLocatedTime":"1970-01-01T07:30:00.000+0730","lastLocatedTime":"2016-06-16T02:17:33.039+0800","maxDetectedRssi":{"apMacAddress":"64:f6:9d:2a:05:00","band":"IEEE_802_11_B","slot":0,"rssi":-58,"antennaIndex":0,"lastHeardInSeconds":1}},"historyLogReason":null,"geoCoordinate":{"latitude":1.3347778969996247,"longitude":103.96366325767761,"unit":"DEGREES"},"networkStatus":"ACTIVE","changedOn":1466014653039,"telemetryList":null,"batteryInfo":{"tolerance":70,"percentRemaining":100,"daysRemaining":0,"batteryAge":0,"lastReceivedTime":"2016-06-09T06:38:29.748+0800","lastReceivedSeqNum":2221},"vendorData":{"vendorId":6286,"elementId":0,"data":"AAMAAQEABAABAQ==","lastReceivedTime":"2016-06-09T06:38:29.748+0800","lastReceivedSeqNum":2221},"sortedEmergencyList":null,"sortedChokepointList":null,"lastBeaconTime":null,"lastBeaconSequenceNumber":2221,"manufacturer":"Ekahau"},{"x":72.013855,"y":141.74767,"z":0.0,"unit":"FEET"},"currentlyTracked":true,"confidenceFactor":312.0,"statistics":{"currentServerTime":"2016-06-16T02:17:38.683+0800","firstLocatedTime":"2016-06-16T01:03:27.408+0800","lastLocatedTime":"2016-06-16T02:11:46.648+0800","maxDetectedRssi":{"apMacAddress":"04:62:73:61:b3:10","band":"IEEE_802_11_B","slot":0,"rssi":-91,"antennaIndex":0,"lastHeardInSeconds":2}},"historyLogReason":null,"geoCoordinate":null,"networkStatus":"ACTIVE","changedOn":1466014306648,"telemetryList":null,"batteryInfo":{"tolerance":20,"percentRemaining":80,"daysRemaining":2948,"batteryAge":29,"lastReceivedTime":"2016-06-16T02:11:45.137+0800","lastReceivedSeqNum":169},"vendorData":{"vendorId":3276,"elementId":0,"data":"AAAOAA==","lastReceivedTime":"2016-06-16T02:11:45.137+0800","lastReceivedSeqNum":169},"sortedEmergencyList":null,"sortedChokepointList":null,"lastBeaconTime":null,"lastBeaconSequenceNumber":169,"manufacturer":"Aeroscout"}]
Cisco Connected Mobile Experiences REST API Guide, Release 10.3148
LocationGET: All Tags
GET: RFID Tag by MAC AddressDescription
This API returns an RFID tag by its MAC address.
HTTP Method
GET
Resource URI
/api/location/v1/tags/:macaddress
Requires OAuth
N
Parameters
Table 71: Parameter Details
DescriptionLocationTypeDefaultRequiredName
RFID Tag MACaddress.
pathReplaceString—Ymacaddress
Content Type
application/json
Sample Output
http://10.68.40.131/api/location/v1/tags/00:18:8e:28:24:26{"macAddress":"00:18:8e:28:24:26","mapInfo":{"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId":"739764660256899136","floorDimension":{"length":118.11024,"width":184.05511,"height":9.84252,"offsetX":0.0,"offsetY":0.0,"unit":"FEET"},"image":{"imageName":"domain_0_1380690706964.png","zoomLevel":4,"width":1440.0,"height":900.0,"size":1440.0,"maxResolution":8.0,"colorDepth":8}},"mapCoordinate":{"x":108.84515,"y":68.62626,"z":0.0,"unit":"FEET"},"currentlyTracked":true,"confidenceFactor":72.0,"statistics":{"currentServerTime":"2016-06-16T02:20:42.974+0800","firstLocatedTime":"1970-01-01T07:30:00.000+0730","lastLocatedTime":"2016-06-16T02:20:39.336+0800","maxDetectedRssi":{"apMacAddress":"64:f6:9d:2a:05:00","band":"IEEE_802_11_B","slot":0,"rssi":-58,"antennaIndex":0,"lastHeardInSeconds":1}},"historyLogReason":null,"geoCoordinate":{"latitude":1.3347778969996247,"longitude":103.96366325767761,"unit":"DEGREES"},"networkStatus":"ACTIVE","changedOn":1466014839336,"telemetryList":null,"batteryInfo":{"tolerance":70,"percentRemaining":100,"daysRemaining":0,"batteryAge":0,"lastReceivedTime":"2016-06-09T06:38:29.748+0800","lastReceivedSeqNum":2221},"vendorData":{"vendorId":6286,"elementId":0,"data":"AAMAAQEABAABAQ==","lastReceivedTime":"2016-06-09T06:38:29.748+0800","lastReceivedSeqNum":2221},"sortedEmergencyList":null,"sortedChokepointList":null,"lastBeaconTime":null,"lastBeaconSequenceNumber":2221,"manufacturer":"Ekahau"}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 149
LocationGET: RFID Tag by MAC Address
GET: Supported Northbound NotificationsDescription
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
Sample Output{"association":{"association":{"name":"association","dataType":"BOOLEAN","nameSpace":"association","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]},"deviceType":{"name":"deviceType","dataType":"ENUM","nameSpace":"association","needValueCheck":false,"evaluateByProvider":false,"validValueSet":["client"]}},"beaconmovement":{"distance":{"name":"distance","dataType":"FLOAT","nameSpace":"beaconmovement","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]}},"absence":{"triggerAbsence":{"name":"triggerAbsence","dataType":"BOOLEAN","nameSpace":"absence","needValueCheck":false,"evaluateByProvider":false,"validValueSet":[]},"deviceType":{"name":"deviceType","dataType":"ENUM","nameSpace":"absence","needValueCheck":false,"evaluateByProvider":false,"validValueSet":["client"]}},"locationupdate":{"deviceType":{"name":"deviceType","dataType":"ENUM","nameSpace":"locationupdate","needValueCheck":true,"evaluateByProvider":false,"validValueSet":["client","tag","interferer"]},"triggerLocationEvent":{"name":"triggerLocationEvent","dataType":"BOOLEAN","nameSpace":"locationupdate","needValueCheck":false,"evaluateByProvider":false,"validValueSet":[]},"hierarchy":{"name":"hierarchy","dataType":"STRING","nameSpace":"locationupdate","needValueCheck":true,"evaluateByProvider":true,"validValueSet":[]}},"inout":{"in/out":{"name":"in/out","dataType":"ENUM","nameSpace":"inout","needValueCheck":false,"evaluateByProvider":false,"validValueSet":["no change","in","out"]},"absence":{"name":"absence","dataType":"BOOLEAN","nameSpace":"inout","needValueCheck":false,"evaluateByProvider":false,"validValueSet":[]},"deviceType":{"name":"deviceType","dataType":"ENUM","nameSpace":"inout","needValueCheck":true,"evaluateByProvider":false,"validValueSet":["client","tag","interferer"]},"hierarchy":{"name":"hierarchy","dataType":"STRING","nameSpace":"inout","needValueCheck":true,"evaluateByProvider":true,"validValueSet":[]}},"beaconabsence":{"absence":{"name":"absence","dataType":"BOOLEAN","nameSpace":"beaconabsence","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]}},"movement":{"distance":{"name":"distance","dataType":"FLOAT","nameSpace":"movement","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]},"deviceType":{"name":"deviceType","dataType":"ENUM","nameSpace":"movement","needValueCheck":true,"evaluateByProvider":false,"validValueSet":["client","tag","interferer"]},"hierarchy":{"name":"hierarchy","dataType":"STRING","nameSpace":"movement","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]}},"any":{"macAddressList":{"name":"macAddressList","dataType":"LIST","nameSpace":"any","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]},"macAddress":{"name":"macAddress","dataType":"STRING","nameSpace":"any","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]}},"areachange":{"buildingChange":{"name":
Cisco Connected Mobile Experiences REST API Guide, Release 10.3150
LocationGET: Supported Northbound Notifications
"buildingChange","dataType":"BOOLEAN","nameSpace":"areachange","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]},"campusChange":{"name":"campusChange","dataType":"BOOLEAN","nameSpace":"areachange","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]},"deviceType":{"name":"deviceType","dataType":"ENUM","nameSpace":"areachange","needValueCheck":true,"evaluateByProvider":false,"validValueSet":["client","tag","interferer"]},"floorChange":{"name":"floorChange","dataType":"BOOLEAN","nameSpace":"areachange","needValueCheck":true,"evaluateByProvider":false,"validValueSet":[]}}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 151
LocationGET: Supported Northbound Notifications
GET: Count of all the BeaconsDescription
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
Sample Output
http://10.68.40.131/api/location/v1/beacon/count
28
Cisco Connected Mobile Experiences REST API Guide, Release 10.3152
LocationGET: Count of all the Beacons
PUT: Place a Beacon at Detected Location on MapDescription
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 72: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Mac address ofbeacon.
pathReplaceString—Ymacaddress
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 153
LocationPUT: Place a Beacon at Detected Location on Map
PUT: Updates Name of a Given BeaconDescription
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 73: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Mac address of beacon.pathReplaceString—Ymacaddress
New values to be used asname.
pathReplaceString—Yname
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3154
LocationPUT: Updates Name of a Given Beacon
GET: List of Beacons Matching Filter CriteriaDescription
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 74: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Reference id of the floor.pathReplaceNumber—Yfloorrefid
Value of the filterString.pathReplaceString—YfilterString
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 155
LocationGET: List of Beacons Matching Filter Criteria
POST: Add Beacon with Minimum FieldsDescription
This API adds a beacon with minimum fields to the store. Example query string /info/mac={mac} andname={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 75: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Value of thequeryString.
pathReplaceString—YqueryString
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3156
LocationPOST: Add Beacon with Minimum Fields
GET: Beacons with Minimum Information for a Floor IDDescription
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 76: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Reference ID ofthe floor.
pathReplaceNumber—Yfloorrefid
Content Type
application/json
Sample Output
http://10.68.40.131/api/location/v1/beacon/info/739764660256899136
["MAC- c8:69:cd:54:2c:3a UUID-null MAJOR-null MINOR-null TYPE-Rogue STATUS-ActiveRSSI-null","MAC- e7:8e:65:42:7b:5e UUID-b9:40:7f:30:f5:f8:46:6e:af:f9:25:55:6b:57:fe:6dMAJOR-31582MINOR-25922 TYPE-Rogue STATUS-Active RSSI--74","MAC- f8:25:1d:38:5f:dfUUID-b9:40:7f:30:f5:f8:46:6e:af:f9:25:55:6b:57:fe:6d MAJOR-24543 MINOR-7480 TYPE-RogueSTATUS-Active RSSI--74","MAC- c8:69:cd:50:29:de UUID-null MAJOR-null MINOR-null TYPE-RogueSTATUS-Active RSSI-null"]
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 157
LocationGET: Beacons with Minimum Information for a Floor ID
GET: List of BeaconsDescription
This API returns list of Beacons.
HTTP Method
GET
Resource URI
/api/location/v1/beacon
Requires OAuth
N
Parameters
None.
Content Type
application/json
Sample Output
http://10.68.40.131/api/location/v1/beacon[{"macAddress":"c8:69:cd:54:2c:3a","name":null,"type":"Rogue","detectedOn":1465384031100,"status":"Active","lastUpdatedOn":1466015949748,"currentServerTime":1466016244167,"expectedHierarchyString":null,"actualHierarchyString":null,"uuid":null,"major":null,"minor":null,"manufacturerId":null,"rssi":null,"mapInfo":{"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>IOT Demo,SingZone","floorRefId":"739764660256899136"},"mapCoordinate":{"x":79.47438,"y":60.84791,"z":0.0,"unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":1466015949748},{"macAddress":"e7:8e:65:42:7b:5e","name":null,"type":"Rogue","detectedOn":1466007673699,"status":"Active","lastUpdatedOn":0,"currentServerTime":1466016244167,"expectedHierarchyString":null,"actualHierarchyString":null,"uuid":"b9:40:7f:30:f5:f8:46:6e:af:f9:25:55:6b:57:fe:6d","major":"31582","minor":"25922","manufacturerId":"4c00","rssi":"-74","mapInfo":{"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId":"739764660256899136"},"mapCoordinate":{"x":110.90741,"y":62.45491,"z":0.0,"unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":0},………{"mapHierarchyString":"Bangalore_Cessna>Building 11>Customer Experience Center","floorRefId":"739764720386534870"},"mapCoordinate":{"x":91.889755,"y":161.0643,"z":0.0,"unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":0},{"macAddress":"34:c0:59:36:71:1d","name":null,"type":"Rogue","detectedOn":1466015514702,"status":"Active","lastUpdatedOn":0,"currentServerTime":1466016244167,"expectedHierarchyString":null,"actualHierarchyString":null,"uuid":null,"major":null,"minor":null,"manufacturerId":null,"rssi":null,"mapInfo":{"mapHierarchyString":"Bangalore_Cessna>Building 11>Customer Experience Center","floorRefId":"739764720386534870"},"mapCoordinate":{"x":91.889755,"y":161.0643,"z":0.0,"unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":0}]
Cisco Connected Mobile Experiences REST API Guide, Release 10.3158
LocationGET: List of Beacons
GET: Beacon by MAC AddressDescription
This API returns Beacon by macaddress.
HTTP Method
GET
Resource URI
/api/location/v1/beacon/:macaddress
Requires OAuth
N
Parameters
Table 77: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Mac address ofbeacon.
pathReplaceString—Ymacaddress
Content Type
application/json
Sample Output
http://10.68.40.131/api/location/v1/beacon/c8:69:cd:54:2c:3a{"macAddress":"c8:69:cd:54:2c:3a","name":null,"type":"Rogue","detectedOn":1465384031100,"status":"Active","lastUpdatedOn":1466015949748,"currentServerTime":1466016328698,"expectedHierarchyString":null,"actualHierarchyString":null,"uuid":null,"major":null,"minor":null,"manufacturerId":null,"rssi":null,"mapInfo":{"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId":"739764660256899136"},"mapCoordinate":{"x":76.43114,"y":58.149662,"z":0.0,"unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":1466015949748}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 159
LocationGET: Beacon by MAC Address
DELETE: Delete Beacon by MAC AddressDescription
This API deletes a Beacon by macaddress.
HTTP Method
DELETE
Resource URI
/api/location/v1/beacon/:macaddress
Requires OAuth
N
Parameters
Table 78: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Mac address ofbeacon to bedeleted.
pathReplaceString—Ymacaddress
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3160
LocationDELETE: Delete Beacon by MAC Address
PUT: Update BeaconDescription
This API updates a given Beacon.
HTTP Method
PUT
Resource URI
/api/location/v1/beacon
Requires OAuth
N
Parameters
Table 79: Parameter Details
DescriptionLocationTypeDefaultRequiredName
MAC Address.bodystring—YmacAddress
Namebodystring—Yname
• Known
• Rogue
• Unplaced
bodyenumerated—Ntype
detectedOnbodynumber—NdetectedOn
• Active
• Missing
• Misplaced
• Inactive
• NeverDetected
bodyenumerated—Nstatus
Last updated on.bodynumber—NlastUpdatedOn
Expected HierarchyString.
bodystring—NexpectedHierarchyString
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 161
LocationPUT: Update Beacon
DescriptionLocationTypeDefaultRequiredName
Actual HierarchyString.
bodystring—NactualHierarchyString
UUIDbodystring—Yuuid
Major.bodystring—Ymajor
Minorbodystring—Yminor
Manufacturer IDbodystring—NmanufacturerId
RSSI value.bodystring—Nrssi
Map Information.bodytext—NmapInfo
Map coordinate.bodytext—NmapCoordinate
Detected Location.bodytext—NdetectedLocation
Configured Location.bodytext—NconfiguredLocation
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3162
LocationPUT: Update Beacon
GET: List of Beacons Present on a FloorDescription
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 80: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Reference ID ofthe floor.
pathReplaceNumber—Yfloorrefid
Content Type
application/json
Sample Output[{"macAddress":"c8:69:cd:54:2c:3a","name":null,"type":"Rogue","detectedOn":1465384031100,"status":"Active","lastUpdatedOn":1466015949748,"currentServerTime":1466016486617,"expectedHierarchyString":null,"actualHierarchyString":null,"uuid":null,"major":null,"minor":null,"manufacturerId":null,"rssi":null,"mapInfo":{"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId":"739764660256899136"},"mapCoordinate":{"x":76.43114,"y":58.149662,"z":0.0,"unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":1466015949748},{"macAddress":"e7:8e:65:42:7b:5e","name":null,"type":"Rogue","detectedOn":1466007673699,"status":"Active","lastUpdatedOn":0,"currentServerTime":1466016486617,"expectedHierarchyString":null,"actualHierarchyString":null,"uuid":"b9:40:7f:30:f5:f8:46:6e:af:f9:25:55:6b:57:fe:6d","major":"31582","minor":"25922","manufacturerId":"4c00","rssi":"-74","mapInfo":{"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId":"739764660256899136"},"mapCoordinate":{"x":110.90741,"y":62.45491,"z":0.0,"unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":0},{"macAddress":"f8:25:1d:38:5f:df","name":null,"type":"Rogue","detectedOn":1465803834008,"status":"Active","lastUpdatedOn":1466012481898,"currentServerTime":1466016486617,"expectedHierarchyString":null,"actualHierarchyString":null,"uuid":"b9:40:7f:30:f5:f8:46:6e:af:f9:25:55:6b:57:fe:6d","major":"24543","minor":"7480","manufacturerId":"4c00","rssi":"-74","mapInfo":{"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>SingZone","floorRefId":"739764660256899136"},"mapCoordinate":{"x":106.88582,"y":70.93849,"z":0.0,"unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":1466012481898},{"macAddress":"c8:69:cd:50:29:de","name":null,"type":"Rogue","detectedOn":1465860354185,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 163
LocationGET: List of Beacons Present on a Floor
"status":"Active","lastUpdatedOn":1466010229973,"currentServerTime":1466016486617,"expectedHierarchyString":null,"actualHierarchyString":null,"uuid":null,"major":null,"minor":null,"manufacturerId":null,"rssi":null,"mapInfo":{"mapHierarchyString":"Singapore>SINGAPORE UE BIZHUB EAST (SNG11)>SNG11-5Fl>MainDemo Theater,SingZone","floorRefId":"739764660256899136"},"mapCoordinate":{"x":83.58248,"y":96.976616,"z":0.0,"unit":"FEET"},"detectedLocation":null,"configuredLocation":null,"lastUpdatedTime":1466010229973}]
Cisco Connected Mobile Experiences REST API Guide, Release 10.3164
LocationGET: List of Beacons Present on a Floor
POST: Add Beacon to the StoreDescription
This API adds a Beacon to the store.
HTTP Method
POST
Resource URI
/api/location/v1/beacon
Requires OAuth
N
Parameters
Table 81: Parameter Details
DescriptionLocationTypeDefaultRequiredName
MAC Address.bodystring—YmacAddress
bodystring—Yname
• Known
• Rogue
• Unplaced
bodyenumerated—Ntype
Detected On.bodynumber—NdetectedOn
• Active
• Missing
• Misplaced
• Inactive
• NeverDetected
bodyenumerated—Nstatus
Last Updated on.bodynumber—NlastUpdatedOn
Expected Hierarchy String.bodystring—NexpectedHierarchyString
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 165
LocationPOST: Add Beacon to the Store
DescriptionLocationTypeDefaultRequiredName
Actual Hierarchy String.bodystring—NactualHierarchyString
UUIDbodystring—Yuuid
Majorbodystring—Ymajor
Minorbodystring—Yminor
Manufacturer IDbodystring—NmanufacturerId
RSSI value.bodystring—Nrssi
Map Info.bodytext—NmapInfo
Map coordinate.bodytext—NmapCoordinate
Detected Location.bodytext—NdetectedLocation
Configured Location.bodytext—NconfiguredLocation
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3166
LocationPOST: Add Beacon to the Store
GET: Active Clients CountDescription
This API returns active clients count.
This includes sleeping static devices which do not send probes, but are still active.Note
HTTP Method
GET
Resource URI
/api/location/v2/clients/count
Requires OAuth
N
Parameters
None.
Sample Output{
macAddress:"b8:e9:37:3c:69:d8",mapInfo:{
mapHierarchyString:"Nortech Campus>Nortech-1>1st Floor",floorRefId:"727035700041482264",floorDimension:{
length:49.9,width:81,height:10,offsetX:0,offsetY:0,unit:"FEET"
},image:{
imageName:"domain_0_1461628766707.png",zoomLevel:4,width:2008,height:1097,size:2008,maxResolution:8,colorDepth:8
},tagList:[
"Land side"]
},mapCoordinate:{
x:50,y:22,z:0,unit:"FEET"
},currentlyTracked:true,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 167
LocationGET: Active Clients Count
confidenceFactor:96,statistics:{
currentServerTime:"2016-06-13T16:52:25.646-0700",firstLocatedTime:"1969-12-31T16:00:00.000-0800",lastLocatedTime:"2016-06-13T16:52:21.191-0700",maxDetectedRssi:{
apMacAddress:"b8:38:61:a8:bc:60",band:"IEEE_802_11_B",slot:2,rssi:-37,antennaIndex:0,lastHeardInSeconds:0
}},historyLogReason:null,geoCoordinate:{
latitude:37.42245292884372,longitude:-121.95980375308643,unit:"DEGREES"
},networkStatus:"ACTIVE",changedOn:1465861941191,ipAddress:[
"10.22.243.128"],userName:"",ssId:"cmx",sourceTimestamp:null,band:"IEEE_802_11_B",apMacAddress:"b8:38:61:a8:bc:60",dot11Status:"ASSOCIATED",manufacturer:"Sonos",areaGlobalIdList:[
118,75,74,73,110,119,120,115
],detectingControllers:"10.22.243.56",bytesSent:7094,bytesReceived:19919,guestUser:false
}]
Cisco Connected Mobile Experiences REST API Guide, Release 10.3168
LocationGET: Active Clients Count
GET: All clientsDescription
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 byMacAddress: api/location/v2/clients?macAddress=x:x:x:x.Search by Username: api/location/v2/clients?username=someUsername. This API also supports paginationbased 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
Sample Output
http://10.68.40.131/api/location/v2/clients
[{"macAddress":"fc:e9:98:2a:8e:2a","mapInfo":{"mapHierarchyString":"Beijing>BEIJING-YINTAI TOWER(BJN6)>BJN6-7Fl>JingShan","floorRefId":"739764660256899130","floorDimension":{"length":145.0,"width":145.0,"height":10.0,"offsetX":0.0,"offsetY":0.0,"unit":"FEET"},"image":{"imageName":"domain_0_1381803717769.jpg","zoomLevel":4,"width":553.0,"height":553.0,"size":553.0,"maxResolution":4.0,"colorDepth":8}},"mapCoordinate":{"x":15.227272,"y":51.00305,"z":0.0,"unit":"FEET"},"currentlyTracked":true,"confidenceFactor":40.0,"statistics":{"currentServerTime":"2016-06-16T02:50:12.085+0800","firstLocatedTime":"2016-06-08T19:07:41.983+0800","lastLocatedTime":"2016-06-16T02:49:25.334+0800","maxDetectedRssi":{"apMacAddress":"64:f6:9d:d3:9b:50","band":"IEEE_802_11_B","slot":0,"rssi":-54,"antennaIndex":0,"lastHeardInSeconds":5}},"historyLogReason":null,"geoCoordinate":null,"networkStatus":"ACTIVE","changedOn":1466016565334,"ipAddress":["10.75.208.106"],"userName":"","ssId":"EXP-CTR","sourceTimestamp":null,"band":"IEEE_802_11_B","apMacAddress":"64:f6:9d:d3:9b:50","dot11Status":"ASSOCIATED","manufacturer":"Apple","areaGlobalIdList":[802,3,2,1,803,804,777,789],"detectingControllers":"10.75.51.125","bytesSent":207547136,"bytesReceived":206672473,"guestUser":false},
l,"networkStatus":"ACTIVE","changedOn":1466016587192,"ipAddress":null,"userName":"","ssId":"","sourceTimestamp":null,"band":"UNKNOWN","apMacAddress":"","dot11Status":"UNKNOWN","manufacturer":"Logitec","areaGlobalIdList":[752,3,2,1,753,754,742,745],"detectingControllers":"10.71.162.9","bytesSent":0,"bytesReceived":0,"guestUser":false}]
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 169
LocationGET: All clients
GET: Collection of Active Clients MAC AddressDescription
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
Sample Output["c0:8a:de:bd:e5:3a","5c:59:48:59:29:21","40:88:05:b2:6c:ec","c0:8a:de:3d:e5:30","98:d6:bb:03:58:d5","e8:4e:84:8b:9f:90","48:45:20:0c:73:58","f0:25:b7:36:db:83","c8:69:cd:50:29:dd","78:da:6e:f6:3f:ff","80:ed:2c:44:e5:ca","08:3d:88:a7:67:6f","d0:4f:7e:34:b1:f2","3c:15:c2:c7:05:c6","ec:35:86:ce:15:94","d8:50:e6:2e:ed:39","fc:e9:98:19:87:6f","40:a6:d9:77:2a:77","60:fe:c5:dc:57:5d","cc:44:63:b7:c9:06","bc:14:85:ac:ba:30","a8:86:dd:ac:1b:f7","a4:34:d9:f8:0f:cf","30:10:e4:c2:9f:04","64:00:f1:79:55:c5","64….."00:23:33:41:5f:80","90:a4:de:29:0d:1d","b4:ce:f6:09:2b:e3"]
Cisco Connected Mobile Experiences REST API Guide, Release 10.3170
LocationGET: Collection of Active Clients MAC Address
GET: Compact History of Client by Date and UsernameDescription
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 82: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Date in format ofyyyy/mm/dd
queryString—Ydate
User name.pathReplaceString—Yusername
Content Type
application/json
Sample Output
http://10.68.40.131/api/location/v1/historylite/byusername/rykikuch{"Data":[{"x":0.0,"y":90.67049,"flr":"739764660256899128","chgOn":"1466016775067","s":"1","ssid":"TKY-ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35, fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0},{"x":0.0,"y":60.44699,"flr":"739764660256899128","chgOn":"1466016753280","s":"1","ssid":"TKY-ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35,fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0},{"x":3.3062298,"y":100.85927,"flr":"739764660256899128","chgOn":"1466016729336","s":"1","ssid":"TKY-ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35,fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0},{"x":2.4152029,"y":94.40629,"flr":"739764660256899128","chgOn":"1466016727243","s":"1","ssid":"TKY-ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35,fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0},{"x":0.0,"y":83.11462,"flr":"739764660256899128","chgOn":"1466016705764","s":"1","ssid":"TKY-ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35,fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0},-…..ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35,fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0},{"x":0.0,"y":68.00287,"flr":"739764660256899128","chgOn":"1466006412975","s":"1","ssid":"TKY-ECN","ap":"10:05:ca:15:61:70","un":"rykikuch","ip":"10.71.160.35,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 171
LocationGET: Compact History of Client by Date and Username
fe80:0000:0000:0000:7a4b:87ff:fe5b:ebe9","lat":-999.0,"long":-999.0}],"Count":210,"Date":"2016/06/16","Username":"rykikuch","Macaddress":"78:4b:87:5b:eb:e9"}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3172
LocationGET: Compact History of Client by Date and Username
GET: Unique MAC Address Seen on a Given Day on a Floor orZone
Description
This API returns the unique MAC address on a given dat on a floore or zone. It expects parameters date andhierarchy. 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 andfloorid or date and zoneid parameters.
When date parameter is not specified, API would use current date as default. Specifying either of the parameterslike hierarchy or floorid or zoneid is mandatory. This API also supports filter by time and filter by distancecriterias. For filter by time, use fromHour and toHour (both in 24 hr format) parameters. For filter by distancequeries, using filter by time is mandatory and supported toHour/fromHour difference is 1 hr only to filter outrelevant 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. Byhierarchy and filter by time:/api/location/v1/history/uniqueclientsbyhierarchy?hierarchy=System%20Campus/BGLD-19/1st%20Floorand 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%20Floorand 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 83: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Hierarchy in formatcampus-name/building-name/floor-name.
queryString—Yhierarchy
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 173
LocationGET: Unique MAC Address Seen on a Given Day on a Floor or Zone
DescriptionLocationTypeDefaultRequiredName
Date in format of yyyy/mm/dd.queryString—Ndate
Floor ID.queryString—Nfloorid
Zone ID.queryString—Nzoneid
FromHour, HH in 24 hourformat.
queryString—NfromHour
ToHour, HH in 24 hour formatqueryString—NtoHour
xqueryString—Nx
yqueryString—Ny
Distance in feetqueryString—Ndistance
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3174
LocationGET: Unique MAC Address Seen on a Given Day on a Floor or Zone
GET: Compact History of Client By Date and IPv4 AddressDescription
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 84: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Date in formatof yyyy/mm/dd.
queryString—Ydate
IPv4 Address.pathReplaceString—Yipv4address
Content Type
application/json
Sample Output
http://10.68.40.131/api/location/v1/historylite/byipaddress/10.68.41.186{"Data":[{"x":77.017044,"y":63.450798,"flr":"739764660256899136","chgOn":"1466017126384","s":"1","ssid":"EXP-CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip":"10.68.41.186","lat":1.3348362417605646,"long":103.963600110401},{"x":73.746574,"y":59.760944,"flr":"739764660256899136","chgOn":"1466017117786","s":"1","ssid":"EXP-CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip":"10.68.41.186","lat":1.3348490318868647,"long":103.96359856354766},{"x":68.30552,"y":59.5387,"flr":"739764660256899136","chgOn":"1466017113711","s":"1","ssid":"EXP-CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip":"10.68.41.186","lat":1.3348575805268508,"long":103.96358673173596},{"x":65.13171,"y":51.720306,"flr":"739764660256899136","chgOn":"1466017109515","s":"1","ssid":"EXP-CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip":"10.68.41.186","lat":1.334879110375031,"long":103.96359186167277},{"x":73.50822,"y":60.077927,"flr":"739764660256899136","chgOn":"1466017105458","s":"1","ssid":"EXP-CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip":"10.68.41.186","lat":1.3348487034026406,"long":103.96359753397321},….CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip":"10.68.41.186","lat":1.3348446311431865,"long":103.96357759122772},{"x":68.51861,"y":59.40737,"flr":"739764660256899136","chgOn":"1466006400371","s":"1","ssid":"EXP-CTR","ap":"64:f6:9d:36:6b:e0","un":"","ip":"10.68.41.186","lat":1.3348575470327593,"long":
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 175
LocationGET: Compact History of Client By Date and IPv4 Address
103.96358741423289}],"Count":748,"Ipv4address":"10.68.41.186","Date":"2016/06/16","Macaddress":"00:19:70:03:22:e3"}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3176
LocationGET: Compact History of Client By Date and IPv4 Address
GET: This API returns history for all clientsDescription
This API returns the history of all active clients (This does not include sleeping static devices that do not sendprobes). It does not support pagination, but you can extract small chunks of data by specifying parameterslocatedAfterTime 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 + fromHourto 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) millisecondsequivalent 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 andless than an hour, the API returns the following error.
ERROR - Cassandra timeout during read query at consistency ONE (1 responses were required but only 0replica responded)
For example,https://<ip-address</api/location/v1/history/clients?locatedAfterTime=1459468800000&locatedBeforeTime=1459636800000returns the ERROR.
This API response returns a maximum of 5000 records without pagination and is sorted based by the MACaddress. Therefore, without using the parameters such as locatedAfterTime and locatedBeforeTime to limitthe number of records of a specific MAC Address, the API response for client history will return only oneMAC Address. The sort order should be by date/time of occurrence.
Note • This API can only support queries when the number of clients is less than 5000 per minute.
• Do not use this API if there are more than 2000 records. For larger datasets, it is recommended touse Northbound Notifications.
HTTP Method
GET
Resource URI
/api/location/v1/history/clients
Requires OAuth
N
Parameters
None.
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 177
LocationGET: This API returns history for all clients
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3178
LocationGET: This API returns history for all clients
GET: History of Client by MAC AddressDescription
This API returns the history of an active client by its MAC address.
HTTP Method
GET
Resource URI
/api/location/v1/history/clients/:macaddress
Requires OAuth
N
Parameters
Table 85: Parameter Details
DescriptionLocationTypeDefaultRequiredName
ClientMacaddress.
pathReplaceString—Ymacaddress
Date in formatof yyyy/mm/dd.
queryString—Ydate
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 179
LocationGET: History of Client by MAC Address
GET: Get all configuration compliance rules for clienttroubleshooting
Description
Get all configuration compliance rules for client troubleshooting
HTTP Method
GET
Resource URI
/api/location/v1/compliance/clientcompliance/rules/:floorid
Requires OAuth
N
Parameters
Table 86: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Reference id ofthe floor
pathReplaceStringYfloorid
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3180
LocationGET: Get all configuration compliance rules for client troubleshooting
GET: Get all configuration compliance rules for clienttroubleshooting from MAC
Description
Get all configuration compliance rules for client troubleshooting
HTTP Method
GET
Resource URI
/api/location/v1/compliance/clientcompliance/rules/mac/:macaddr/:floorid
Requires OAuth
N
Parameters
Table 87: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Reference id ofthe floor
pathReplaceNumberYmacaddr
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 181
LocationGET: Get all configuration compliance rules for client troubleshooting from MAC
POST: Execute a compliance rule for troubleshootingDescription
Executes a compliance rule for client troubleshooting
HTTP Method
POST
Resource URI
/api/location/v1/compliance/client/run
Requires OAuth
N
Parameters
Table 88: Parameter Details
DescriptionLocationTypeDefaultRequiredName
ruleidbodystringNruleid
unamebodystringNuname
passwdbodystringNpasswd
controlleripbodystringNcontrollerip
connectiontypebodystringNconnectiontype
apunamebodystringNapuname
appasswdbodystringNappasswd
flooridbodystringNfloorid
macaddrbodystringNmacaddr
testnamebodystringNtestname
starttimebodynumberNstarttime
endtimebodynumberNendtime
markerxbodystringNmarkerx
Cisco Connected Mobile Experiences REST API Guide, Release 10.3182
LocationPOST: Execute a compliance rule for troubleshooting
DescriptionLocationTypeDefaultRequiredName
markerybodystringNmarkery
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 183
LocationPOST: Execute a compliance rule for troubleshooting
GET: Get interferer by macaddressDescription
This API returns an interferer by macaddress
HTTP Method
GET
Resource URI
/api/location/v1/interferers/:macaddress
Requires OAuth
N
Parameters
Table 89: Parameter Details
DescriptionLocationTypeDefaultRequiredName
InterfererMacaddress
pathReplaceStringYmacaddress
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3184
LocationGET: Get interferer by macaddress
GET: Get total number of interferersDescription
This API returns number of interferers
HTTP Method
GET
Resource URI
/api/location/v1/interferers/count
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 185
LocationGET: Get total number of interferers
GET: Get all interferersDescription
This API returns all interferers and also supports searching by floor. .
HTTP Method
GET
Resource URI
/api/location/v1/interferers
Requires OAuth
N
Parameters
None.
Content Type
application/json
Content Type
application/json
Usage Guidelines Search by Floor:http://<cmx-ip-address>/api/location/v1/interferers/floorrefid=<floorrefid>For Example:http://10.0.0.1/api/location/v1/interferers/floorrefid=1
Search by Page and Page Number: (As long as there is data you can keep paginating by incrementing the pageand the pageSize numbers)http://<cmx-ip-address>/api/location/v1/interferers?page=<pagenumber>&pageSize=<pagesize>For Example:http://10.0.0.1/api/location/v1/interferers/page=1&pageSize=2
Cisco Connected Mobile Experiences REST API Guide, Release 10.3186
LocationGET: Get all interferers
GET: This API returns all RFID tags with minimal informationDescription
This API returns all RFID tags.
HTTP Method
GET
Resource URI
/api/location/v1/tags/summary
Requires OAuth
N
Parameters
None.
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 187
LocationGET: This API returns all RFID tags with minimal information
GET: Returns active clients count and mac addresses for eachregistered zone
Description
This API returns the count of active clients along with their macaddresses for each registered zone. This APIexpects the debug flag to be turned on in the POST: Add New Zone API (/api/config/v1/zoneCountParams/<cluster-id>)
.
HTTP Method
GET
Resource URI
/api/location/v1/clients/count/byzone/detail
Requires OAuth
N
Parameters
Table 90: Parameter Details
DescriptionLocationTypeDefaultRequiredName
zoneIdqueryStringYzoneId
Content Type
application/json
Usage Guidelines
This API expects the debug flag turned on in the Zone Count Register API under configuration service/api/config/v1/zoneCountParams/1.
Note
http://<cmx-ip-address>/api/location/v1/clients/count/byzone/detail?zoneid=<zoneid>For Example:http://10.0.0.1/api/location/v1/clients/count/byzone/detail?zoneid=145
Sample Output{
MacAddress: ["6c:40:08:a5:d2:d0",
Cisco Connected Mobile Experiences REST API Guide, Release 10.3188
LocationGET: Returns active clients count and mac addresses for each registered zone
"a4:b8:05:9c:a0:d0","a0:8d:16:f3:58:ab","cc:3d:82:52:4b:8a","20:7d:74:1a:c2:ba","34:a3:95:8d:43:ac","d8:d1:cb:a4:13:7a","3c:a9:f4:7f:29:4c","38:ca:da:24:15:05","a4:b8:05:bf:58:d5","5c:e0:c5:c7:1b:54","ac:5f:3e:b9:84:b8","60:f1:89:12:f7:6d","d8:bb:2c:15:27:1a","a4:b8:05:d1:4e:0b","10:4a:7d:34:da:ff","64:bc:0c:49:18:6a","60:f4:45:77:a4:47","78:fd:94:1b:ad:b7","ac:cf:85:01:2c:22","88:1f:a1:72:e4:3f","70:81:eb:e6:f1:c8","e8:50:8b:60:d0:bc","e8:91:20:a9:df:c1","e8:b1:fc:d3:1f:3f","a0:18:28:a7:f5:2d","70:48:0f:88:0e:65","b8:53:ac:34:5d:1a","98:01:a7:ac:8c:c9","60:f1:89:35:c7:2a","60:f1:89:86:9e:19","cc:3a:61:27:75:3d","c8:e0:eb:18:74:4d","c0:cc:f8:2c:dd:70","20:3c:ae:af:36:de","88:07:4b:b2:03:7f","e8:50:8b:f0:6e:ba","64:89:9a:33:f2:e1","60:f1:89:47:0d:1f","ec:1f:72:af:98:6c","a0:99:9b:14:8b:bd","f4:5c:89:bc:47:61","e8:f2:e2:e3:d4:50","fc:db:b3:22:b8:cf","70:81:eb:95:d0:5b","cc:20:e8:09:50:64","64:a3:cb:51:89:fc","18:65:90:0b:e5:32","78:fd:94:b0:90:af","5c:e0:c5:07:a7:56","e4:a7:a0:b3:70:6d","a4:b8:05:9e:80:70","60:f1:89:7e:cd:48","34:36:3b:d2:01:42","2c:33:61:84:fe:51","48:59:29:a6:df:9a","b8:44:d9:ae:fd:2e","44:85:00:69:1a:4a","bc:3b:af:1f:53:0d","a0:91:69:df:a6:0d","18:65:90:21:a6:17","a4:b8:05:dd:5a:19","98:01:a7:a0:fa:a7","24:df:6a:0d:05:39","2c:0e:3d:13:08:87","e8:2a:ea:77:ec:0a","f4:5c:89:8f:0f:a3","ac:bc:32:b4:02:0f","d0:e1:40:9f:1f:88","e8:2a:ea:06:fe:be","24:a0:74:f2:c5:b8","70:3e:ac:19:dd:db","a0:99:9b:14:f3:cb","e4:a4:71:51:fc:2f",
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 189
LocationGET: Returns active clients count and mac addresses for each registered zone
"e8:b1:fc:c5:0f:80","70:3e:ac:15:b0:0d","b8:53:ac:78:5a:62","90:3c:92:e0:cf:e7","98:5a:eb:8f:00:14","c8:1e:e7:8b:d7:25","34:36:3b:d1:ec:ec","98:01:a7:aa:9a:45","90:72:40:e8:80:83","cc:79:4a:fa:be:47","78:7e:61:52:60:90","b4:8b:19:e8:a8:07","a0:0b:ba:e7:3c:57","a0:99:9b:08:18:bf","60:f1:89:e6:48:66","a0:99:9b:08:7c:f9","c0:64:c6:fb:3a:54","b4:18:d1:32:67:75","c8:e0:eb:17:3b:8b","b8:53:ac:7d:b5:f0","50:1a:c5:ec:b8:11","60:f1:89:0b:6b:d2","5c:c5:d4:11:24:52","d0:a6:37:a8:24:c5","f0:99:bf:e2:1a:ec","24:77:03:25:c6:28"
],Duration : {
start: "2016/11/08 15:34:41",end: "2016/11/08 15:44:41",
},Count : 100
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3190
LocationGET: Returns active clients count and mac addresses for each registered zone
GET: Returns active clients count for each registered zoneDescription
This API returns the list of active clients for each registered zones. Zones are registered using POST: AddNew Zone (/api/config/v1/zoneCountParams/:clusterID)
HTTP Method
GET
Resource URI
/api/location/v1/clients/count/byzone
Requires OAuth
N
Parameters
None.
Content Type
application/json
Usage Guidelines http://<cmx-ip-address>/api/location/v1/clients/count/byzoneFor Example:http://10.0.0.1/api/location/v1/clients/count/byzone
Sample Output{
ZoneCounts: {zoneCountList: [
{zoneId: 13,hierarchy: "Nortech Campus/Nortech Building/Security Floor/zone1",zoneName: "zone1",zoneCount: 4
},{
zoneId: 145,hierarchy: "System Campus/SJC-24/3rd Floor/Zone-2",zoneName: "Zone-2",zoneCount: 83
},{
zoneId: 12,hierarchy: "Nortech Campus/Nortech Building/Security Floor/sharang-zone",zoneName: "sharang-zone",zoneCount: 5
},{
zoneId: 144,hierarchy: "System Campus/SJC-24/3rd Floor/Zone-1",zoneName: "Zone-1",
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 191
LocationGET: Returns active clients count for each registered zone
zoneCount: 107}
],totalZones: 4,duration: {
start: "2016/11/08 16:23:51",end: "2016/11/08 16:33:51",
}}
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3192
LocationGET: Returns active clients count for each registered zone
GET : Get Active APsDescription
This API gets list of all active access points.
HTTP Method
GET
Resource URI
/location/v1/activeaps
Requires OAuth
N
Parameters
None
Content Type
application/json
Sample Output
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 193
LocationGET : Get Active APs
GET: Get Count of Active APsDescription
This API gets count of all active access points.
HTTP Method
GET
Resource URI
/location/v1/activeaps/count
Requires OAuth
N
Parameters
None
Content Type
application/json
Sample Output
Cisco Connected Mobile Experiences REST API Guide, Release 10.3194
LocationGET: Get Count of Active APs
GET: Get List of Missing APsDescription
This API gets list of all missing APs.
HTTP Method
GET
Resource URI
/location/v1/missingaps
Requires OAuth
N
Parameters
None
Content Type
application/json
Sample Output
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 195
LocationGET: Get List of Missing APs
GET: Get Count of Missing APsDescription
This API gets the count of all missing APs.
HTTP Method
GET
Resource URI
/location/v1/missingaps/count
Requires OAuth
N
Parameters
None
Content Type
application/json
Sample Output
Cisco Connected Mobile Experiences REST API Guide, Release 10.3196
LocationGET: Get Count of Missing APs
Presence
• GET: Count of Passersby Today, page 201
• GET: Count of Passersby Yesterday, page 202
• GET: Average Count of Passersby in Last 3 Days, page 203
• GET: Average Count of Passersby in the Last 7 days, page 204
• GET: Average Count of Passersby in the Last 30 Days, page 205
• GET: Sum of Passerby Counts in the Specified Date Range, page 206
• GET: Sum of Passerby Counts in the Last 3 Days, page 207
• GET: Sum of Passerby Counts in the Last 7 Days, page 208
• GET: Count of Passersby on a Given Date, page 209
• GET: Sum of Passerby Counts in the Last 30 days, page 210
• GET: Hourly Count of Passersby Today, page 211
• GET: Hourly Count of Passersby Yesterday, page 212
• GET: Hourly Count of Passersby for Last 3 days, page 213
• GET: Hourly Count of Passersby for a Day, page 215
• GET: Daily Count of Passersby for a Specified Date Range, page 216
• GET: Daily Count of Passersby for the Last 7 days, page 218
• GET: Daily count of passersby for the last 30 days, page 220
• GET: Daily Count of Passersby by hour for the Specified Date Range, page 222
• GET: Excluded Client Counts, page 225
• GET: Active Clients, page 226
• GET: Client Detail, page 230
• GET: Count of Connected Visitors for a Date, page 235
• GET: Count of Connected Visitors Seen today Until Now, page 236
• GET: Count of Connected Visitors Seen Yesterday, page 237
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 197
• GET: Average Count of Connected Visitors Seen in Last 3 Days, page 238
• GET: Average Count of Connected Visitors Seen in Last 7 Days, page 239
• GET: Average Count of Connected Visitors seen in last 30 Days, page 240
• GET: Sum of Connected Visitor Counts in Last 3 days, page 241
• GET: Sum of Connected Visitor Counts in Last 7 days, page 242
• GET: Sum of Connected Visitor Counts in Last 30 days, page 243
• GET: Sum of Connected Visitor Counts in the Specified Date Range, page 244
• GET: Hourly Count of Connected Visitors Today, page 245
• GET: Hourly Count of Connected Visitors Yesterday, page 246
• GET: Hourly Count of Connected Visitors in Last 3 Days, page 247
• GET: Hourly Count of Connected Visitors for the Specified Day, page 248
• GET: Daily Count of Connected Visitors for the Specified Date Range, page 249
• GET: Daily Count of Connected Visitors for Last 7 days, page 251
• GET: Daily Count of Connected Visitors for last 30 Days, page 252
• GET: Daily Count of Connected Visitors by Hour for the Specified Date Range, page 253
• GET: Site KPI Summary for Specified Date or Date Range, page 255
• GET: Site KPI Summary for Today, page 258
• GET: Site KPI Summary for Yesterday, page 259
• GET: Site KPI Summary for Last 3 Days, page 260
• GET: Site KPI Summary for last 7 days, page 261
• GET: Site KPI Summary for Last 30 Days, page 262
• GET: Site Insights for Specified Date or Date Range, page 263
• GET: Average Count of Repeat Visitors for Last 7 Days, page 266
• GET: Average Count of Repeat Visitors for Last 30 days, page 267
• GET: Sum of Repeat Visitor Counts for Last 3 days, page 268
• GET: Sum of Repeat Visitor Counts for Last 7 days, page 269
• GET: Sum of Repeat Visitor Counts for Last 30 days, page 270
• GET: Hourly Count of Repeat Visitors for a Day, page 271
• GET: Hourly Count of Repeat Visitors Today, page 272
• GET: Hourly Count of Repeat Visitors Yesterday, page 273
• GET: Count of Repeat Visitors for a Date or Date Range, page 274
• GET: Count of Repeat Visitors for Today, page 275
• GET: Count of Repeat Visitors for Yesterday, page 276
Cisco Connected Mobile Experiences REST API Guide, Release 10.3198
Presence
• GET: Average Count of Repeat Visitors for Last 3 days, page 277
• GET: Average Count of Repeat Visitors for Specified Date Range, page 278
• GET: Hourly Count of Repeat Visitors for Last 3 Days, page 279
• GET: Repeat Visitor Summary for a Day, page 280
• GET: Repeat Visitor Summary for a Week, page 281
• GET: Repeat Visitor Summary for a Month, page 282
• GET: Daily Count of Repeat Visitors for Specified Date Range, page 283
• GET: Daily Count of Repeat Visitors for Last 7 Days, page 285
• GET: Daily Count of Repeat Visitors for Last 30 days, page 286
• GET: Peak Hour of Visitors Today, page 287
• GET: Count of Visitors Today, page 288
• GET: Count of Visitors Yesterday, page 289
• GET: Count of Unique Visitors for Last 3 Days, page 290
• GET: Count of Unique Visitors for Last Week, page 291
• GET: Count of Unique Visitors for Last Month, page 292
• GET: Count of Unique Visitors for a Date/Date Range, page 293
• GET: Sum of Visitor Counts for a Date Range, page 294
• GET: Sum of Visitor Counts for the Last 3 Days, page 295
• GET: Sum of Visitor Counts for the Last Week, page 296
• GET: Sum of Visitor Counts for the Last Month, page 297
• GET: Hourly Count of Visitors Today, page 298
• GET: Hourly Count of Visitors Yesterday, page 299
• GET: Hourly Count of Visitors for Last 3 Days, page 300
• GET: Hourly Count of Visitors for a Day, page 301
• GET: Daily Count of Visitors for a Date Range, page 302
• GET: Daily Count of Visitors for Last Week, page 303
• GET: Daily Count of Visitors for Last Month, page 304
• GET: Daily Count of Visitors by Hour Category for a Date Range, page 305
• GET: Visitor Summary for a Day, page 307
• GET: Visitor Summary for Week, page 308
• GET: Visitor Summary for Month, page 309
• GET: Count of Visitors by Dwell Level for a Date or Date Range, page 310
• GET: Count of Visitors by Dwell Level for Today, page 311
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 199
Presence
• GET: Count of Visitors by Dwell Level for Yesterday, page 312
• GET: Count of Visitors by Dwell Level for Last 3 Days, page 313
• GET: Count of Visitors by Dwell Level for Last 7 Days, page 314
• GET: Count of Visitors by Dwell Level for Last 30 Days, page 315
• GET: Average Count of Visitors by Dwell Level for Last 7 Days, page 316
• GET: Average Count of Visitors by Dwell Level for Last 30 Days, page 317
• GET: Hourly Count of Visitors by Dwell Level for a Specific Day, page 318
• GET: Hourly Count of Visitors by Dwell Level for Today, page 319
• GET: Average Visitor Dwell Time by Dwell Level for Last 7 Days, page 320
• GET: Average Visitor Dwell Time by Dwell Level for Last 30 Days, page 321
• GET: Daily Average Visitor Dwell Time by Dwell Level for a Specific Date Range, page 322
• GET: Daily Average Visitor Dwell Time by Dwell Level for Last 7 Days, page 324
• GET: Daily Average Visitor Dwell Time by Dwell Level for Last 30 Days, page 325
• GET: Hourly Count of Visitors by Dwell level for Yesterday, page 326
• GET: Hourly Count of Visitors by Dwell Level for Last 3 Days, page 327
• GET: Daily Count of Visitors by Dwell Level for a Specific Date Range, page 328
• GET: Daily Count of Visitors by Dwell Level for Last 7 Days, page 330
• GET: Daily Count of Visitors by Dwell Level for Last 30 Days, page 331
• GET: Average Visitor Dwell Time for the Specific Date or Date Range, page 332
• GET: Average Visitor Dwell Time for Today, page 333
• GET: Average Visitor Dwell Time for Yesterday, page 334
• GET: Average Visitor Dwell Time for Last 3 Days, page 335
• GET: Average Visitor Dwell Time for Last 7 Days, page 336
• GET: Average Visitor Dwell Time for Last 30 Days, page 337
• GET: Average Visitor Dwell Time by Dwell Level for a Specific Date or Date Range, page 338
• GET: Average Visitor Dwell Time by Dwell Level for Today, page 340
• GET: Average Visitor Dwell Time by Dwell Level for Yesterday, page 341
• GET: Average Visitor Dwell Time by Dwell Level for Last 3 days, page 342
Cisco Connected Mobile Experiences REST API Guide, Release 10.3200
Presence
GET: Count of Passersby TodayDescription
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 91: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/count/today?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 201
PresenceGET: Count of Passersby Today
GET: Count of Passersby YesterdayDescription
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 92: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/count/yesterday?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3202
PresenceGET: Count of Passersby Yesterday
GET: Average Count of Passersby in Last 3 DaysDescription
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
Parameters
Table 93: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/count/3days?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 203
PresenceGET: Average Count of Passersby in Last 3 Days
GET: Average Count of Passersby in the Last 7 daysDescription
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 94: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/count/lastweek?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3204
PresenceGET: Average Count of Passersby in the Last 7 days
GET: Average Count of Passersby in the Last 30 DaysDescription
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
Parameters
Table 95: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/count/lastmonth?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 205
PresenceGET: Average Count of Passersby in the Last 30 Days
GET: Sum of Passerby Counts in the Specified Date RangeDescription
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
Parameters
Table 96: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start Date informat ofyyyy-mm-dd
queryString—YstartDate
End Date informat ofyyyy-mm-dd
queryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/total?siteId=<SiteID>&startDate=yyyy-mm-dd&endDate=yyyy-mm-dd
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3206
PresenceGET: Sum of Passerby Counts in the Specified Date Range
GET: Sum of Passerby Counts in the Last 3 DaysDescription
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 97: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/total/3days?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 207
PresenceGET: Sum of Passerby Counts in the Last 3 Days
GET: Sum of Passerby Counts in the Last 7 DaysDescription
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 98: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/total/lastweek?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3208
PresenceGET: Sum of Passerby Counts in the Last 7 Days
GET: Count of Passersby on a Given DateDescription
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 99: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Date in formatof yyyy-mm-dd
queryString—Ydate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/count?siteId=<Site ID>&date=<date inyyyy-mm-dd>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 209
PresenceGET: Count of Passersby on a Given Date
GET: Sum of Passerby Counts in the Last 30 daysDescription
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 100: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/total/lastmonth?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3210
PresenceGET: Sum of Passerby Counts in the Last 30 days
GET: Hourly Count of Passersby TodayDescription
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 101: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/hourly/today?siteId=<Site ID>
Sample Output{
"0":85,"1":45,"2":42,"3":45,"4":46,"5":48,"6":89,"7":180,"8":316,"9":618,"10":886,"11":587,"12":263
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 211
PresenceGET: Hourly Count of Passersby Today
GET: Hourly Count of Passersby YesterdayDescription
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 102: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/hourly/yesterday?siteId=<Site ID>
Sample Output{
"0":85,"1":45,"2":42,"3":45,"4":46,"5":48,"6":89,"7":180,"8":316,"9":618,"10":886,"11":587,"12":263
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3212
PresenceGET: Hourly Count of Passersby Yesterday
GET: Hourly Count of Passersby for Last 3 daysDescription
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 103: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/hourly/3days?siteId=<Site ID>
Sample Output{
"2017-02-27":{"0":0,"1":61,"2":71,"3":71,"4":19,"5":43,"6":119,"7":182,"8":352,"9":732,"10":887,"11":681,"12":643,"13":834,"14":690,"15":605,"16":701,"17":916,"18":990,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 213
PresenceGET: Hourly Count of Passersby for Last 3 days
"19":1124,"20":902,"21":604,"22":314,"23":150
},"2017-02-28":{
"0":143,"1":47,"2":34,"3":39,"4":62,"5":35,"6":71,"7":159,"8":298,"9":739,"10":820,"11":648,"12":577,"13":664,"14":702,"15":542,"16":604,"17":725,"18":1112,"19":1097,"20":919,"21":706,"22":477,"23":188
},"2017-03-01":{
"0":85,"1":45,"2":42,"3":45,"4":46,"5":48,"6":89,"7":180,"8":316,"9":618,"10":886,"11":587,"12":288
}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3214
PresenceGET: Hourly Count of Passersby for Last 3 days
GET: Hourly Count of Passersby for a DayDescription
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 104: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Date in formatof yyyy-mm-dd
queryString—Ydate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/hourly?siteId=<Site ID>&date=<date inyyyy-mm-dd>
Sample Output{
"0":85,"1":45,"2":42,"3":45,"4":46,"5":48,"6":89,"7":180,"8":316,"9":618,"10":886,"11":586,"12":321
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 215
PresenceGET: Hourly Count of Passersby for a Day
GET: Daily Count of Passersby for a Specified Date RangeDescription
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 105: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start Date inyyyy-mm-ddformat
queryString—YstartDate
End Date inyyyy-mm-ddformat
queryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/daily?siteId=<Site ID>&startDate=<date inyyyy-mm-dd>&endDate=<date in yyyy-mm-dd>
Sample Output{
"2017-02-01":0,"2017-02-02":0,"2017-02-03":0,"2017-02-04":0,"2017-02-05":0,"2017-02-06":0,"2017-02-07":0,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3216
PresenceGET: Daily Count of Passersby for a Specified Date Range
"2017-02-08":0,"2017-02-09":0,"2017-02-10":0,"2017-02-11":0,"2017-02-12":0,"2017-02-13":0,"2017-02-14":7221,"2017-02-15":8461,"2017-02-16":12151,"2017-02-17":11309,"2017-02-18":11968,"2017-02-19":8076,"2017-02-20":11406,"2017-02-21":8776,"2017-02-22":10403,"2017-02-23":10149,"2017-02-24":9566,"2017-02-25":9215,"2017-02-26":7042,"2017-02-27":10073,"2017-02-28":9599,"2017-03-01":4438
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 217
PresenceGET: Daily Count of Passersby for a Specified Date Range
GET: Daily Count of Passersby for the Last 7 daysDescription
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 106: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/daily/lastweek?siteId=<Site ID>
Sample Output{
"2017-02-01":0,"2017-02-02":0,"2017-02-03":0,"2017-02-04":0,"2017-02-05":0,"2017-02-06":0,"2017-02-07":0,"2017-02-08":0,"2017-02-09":0,"2017-02-10":0,"2017-02-11":0,"2017-02-12":0,"2017-02-13":0,"2017-02-14":7221,"2017-02-15":8461,"2017-02-16":12151,"2017-02-17":11309,"2017-02-18":11968,"2017-02-19":8076,"2017-02-20":11406,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3218
PresenceGET: Daily Count of Passersby for the Last 7 days
"2017-02-21":8776,"2017-02-22":10403,"2017-02-23":10149,"2017-02-24":9566,"2017-02-25":9215,"2017-02-26":7042,"2017-02-27":10073,"2017-02-28":9599,"2017-03-01":4438
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 219
PresenceGET: Daily Count of Passersby for the Last 7 days
GET: Daily count of passersby for the last 30 daysDescription
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 107: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/daily/lastmonth?siteId=<Site ID>
Sample Output{
"2017-01-31":0,"2017-02-01":0,"2017-02-02":0,"2017-02-03":0,"2017-02-04":0,"2017-02-05":0,"2017-02-06":0,"2017-02-07":0,"2017-02-08":0,"2017-02-09":0,"2017-02-10":0,"2017-02-11":0,"2017-02-12":0,"2017-02-13":0,"2017-02-14":7221,"2017-02-15":8461,"2017-02-16":12151,"2017-02-17":11309,"2017-02-18":11968,"2017-02-19":8076,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3220
PresenceGET: Daily count of passersby for the last 30 days
"2017-02-20":11406,"2017-02-21":8776,"2017-02-22":10403,"2017-02-23":10149,"2017-02-24":9566,"2017-02-25":9215,"2017-02-26":7042,"2017-02-27":10073,"2017-02-28":9599,"2017-03-01":4483
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 221
PresenceGET: Daily count of passersby for the last 30 days
GET: Daily Count of Passersby by hour for the Specified DateRange
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 108: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start Date inyyyy-mm-ddformat
queryString—YstartDate
End Date inyyyy-mm-ddformat
queryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/daily/hourcategory?siteId=<SiteID>&startDate=<date in yyyy-mm-dd>&endDate=<date in yyyy-mm-dd>
Sample Output{
"2017-02-01":{"business_hours":null,"evening_hours":null,"morning_hours":null
Cisco Connected Mobile Experiences REST API Guide, Release 10.3222
PresenceGET: Daily Count of Passersby by hour for the Specified Date Range
},"2017-02-02":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-03":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-04":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-05":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-06":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-07":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-08":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-09":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-10":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-11":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-12":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-13":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-02-14":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-15":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-16":{
"business_hours":0,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 223
PresenceGET: Daily Count of Passersby by hour for the Specified Date Range
"evening_hours":0,"morning_hours":0
},"2017-02-17":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-18":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-19":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-20":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-21":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-22":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-23":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-24":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-25":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-26":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-27":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-02-28":{
"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-03-01":{
"business_hours":null,"evening_hours":null,"morning_hours":null
}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3224
PresenceGET: Daily Count of Passersby by hour for the Specified Date Range
GET: Excluded Client CountsDescription
This API returns the client counts excluded by filters.
HTTP Method
GET
Resource URI
/api/presence/v1/excluded
Requires OAuth
N
Parameters
Table 109: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—NsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/excluded?siteId=<Site ID>
Sample Output{
"repeat":0,"dwell":0,"ssid":0
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 225
PresenceGET: Excluded Client Counts
GET: Active ClientsDescription
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
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/excluded?siteId=<Site ID>
Sample Output[
{"siteEntries":{
"1487056035936":{"macAddress":"ac:c3:3a:87:5c:79","status":"PASSERBY","siteId":1487056035936,"siteName":"PSL NOC","firstRssiTime":1488360873407,"lastRssiTime":1488360873407,"lastMarkedPasserBy":1488360873407,"firstMarkedVisitor":0,"lastMarkedVisitor":0,"firstMarkedAssociated":0,"lastMarkedAssociated":0,"lastInfoTime":0,"rssi":-83,"currentApMacAddress":"00:2a:10:f8:87:50","currentApName":null,"lastApMacAddress":null,"lastApName":null,"controller":"10.222.175.13","firstRssiTimeStamp":"2017-03-01 09:34:407","lastRssiTimeStamp":"2017-03-01 09:34:407","lastMarkedPasserByTimeStamp":"2017-03-01 09:34:407","firstMarkedVisitorTimeStamp":"null","lastMarkedVisitorTimeStamp":"null","lastMarkedAssociatedTimeStamp":"null","firstMarkedAssociatedTimeStamp":"null",
Cisco Connected Mobile Experiences REST API Guide, Release 10.3226
PresenceGET: Active Clients
"lastInfoTimeStamp":"null","lastHeard":1488360873407
}},"macAddress":"ac:c3:3a:87:5c:79","changedOn":1488360873407,"status":"PASSERBY","ipv4Address":null,"ipv6Address":null,"ssid":null,"bytesReceived":0,"bytesSent":0,"lastSiteId":0,"currentSiteId":1487056035936,"rssi":-83,"currentSiteName":"PSL NOC","changedOnTimeStamp":"2017-03-01 09:34:407","lastApMacAddress":"","currentApMacAddress":"00:2a:10:f8:87:50","currentApName":null,"lastApName":"","lastSiteName":""
},{
"siteEntries":{"1487056035936":{
"macAddress":"cc:61:e5:88:f0:d8","status":"PASSERBY","siteId":1487056035936,"siteName":"PSL NOC","firstRssiTime":1488360977448,"lastRssiTime":1488361771824,"lastMarkedPasserBy":1488361771824,"firstMarkedVisitor":0,"lastMarkedVisitor":0,"firstMarkedAssociated":0,"lastMarkedAssociated":0,"lastInfoTime":0,"rssi":-84,"currentApMacAddress":"84:3d:c6:14:73:50","currentApName":null,"lastApMacAddress":"00:2a:10:f8:87:50","lastApName":null,"controller":"10.222.175.13","firstRssiTimeStamp":"2017-03-01 09:36:448","lastRssiTimeStamp":"2017-03-01 09:49:824","lastMarkedPasserByTimeStamp":"2017-03-01 09:49:824","firstMarkedVisitorTimeStamp":"null","lastMarkedVisitorTimeStamp":"null","lastMarkedAssociatedTimeStamp":"null","firstMarkedAssociatedTimeStamp":"null","lastInfoTimeStamp":"null","lastHeard":1488361771824
},"1487260407843":{
"macAddress":"cc:61:e5:88:f0:d8","status":"PASSERBY","siteId":1487260407843,"siteName":"NOC","firstRssiTime":1488361225740,"lastRssiTime":1488361589829,"lastMarkedPasserBy":1488361589829,"firstMarkedVisitor":0,"lastMarkedVisitor":0,"firstMarkedAssociated":0,"lastMarkedAssociated":0,"lastInfoTime":0,"rssi":-82,"currentApMacAddress":"84:3d:c6:0a:bb:80","currentApName":null,"lastApMacAddress":null,"lastApName":null,"controller":"10.222.175.13",
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 227
PresenceGET: Active Clients
"firstRssiTimeStamp":"2017-03-01 09:40:740","lastRssiTimeStamp":"2017-03-01 09:46:829","lastMarkedPasserByTimeStamp":"2017-03-01 09:46:829","firstMarkedVisitorTimeStamp":"null","lastMarkedVisitorTimeStamp":"null","lastMarkedAssociatedTimeStamp":"null","firstMarkedAssociatedTimeStamp":"null","lastInfoTimeStamp":"null","lastHeard":1488361589829
}},"macAddress":"cc:61:e5:88:f0:d8","changedOn":1488361771824,"status":"PASSERBY","ipv4Address":null,"ipv6Address":null,"ssid":null,"bytesReceived":0,"bytesSent":0,"lastSiteId":1487056035936,"currentSiteId":1487056035936,"rssi":-84,"currentSiteName":"PSL NOC","changedOnTimeStamp":"2017-03-01 09:49:824","lastApMacAddress":"84:3d:c6:14:73:50","currentApMacAddress":"84:3d:c6:14:73:50","currentApName":null,"lastApName":null,"lastSiteName":"PSL NOC"
},{
"siteEntries":{"1487056035936":{
"macAddress":"dc:1a:c5:4c:c7:d3","status":"PASSERBY","siteId":1487056035936,"siteName":"PSL NOC","firstRssiTime":1488361425736,"lastRssiTime":1488361425736,"lastMarkedPasserBy":1488361425736,"firstMarkedVisitor":0,"lastMarkedVisitor":0,"firstMarkedAssociated":0,"lastMarkedAssociated":0,"lastInfoTime":0,"rssi":-87,"currentApMacAddress":"00:2a:10:ee:40:40","currentApName":null,"lastApMacAddress":null,"lastApName":null,"controller":"10.222.175.13","firstRssiTimeStamp":"2017-03-01 09:43:736","lastRssiTimeStamp":"2017-03-01 09:43:736","lastMarkedPasserByTimeStamp":"2017-03-01 09:43:736","firstMarkedVisitorTimeStamp":"null","lastMarkedVisitorTimeStamp":"null","lastMarkedAssociatedTimeStamp":"null","firstMarkedAssociatedTimeStamp":"null","lastInfoTimeStamp":"null","lastHeard":1488361425736
}},"macAddress":"dc:1a:c5:4c:c7:d3","changedOn":1488361427739,"status":"PASSERBY","ipv4Address":null,"ipv6Address":null,"ssid":null,"bytesReceived":0,"bytesSent":0,"lastSiteId":1487056035936,"currentSiteId":1487056035936,"rssi":-87,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3228
PresenceGET: Active Clients
"currentSiteName":"PSL NOC","changedOnTimeStamp":"2017-03-01 09:43:739","lastApMacAddress":"00:2a:10:ee:40:40","currentApMacAddress":"00:2a:10:ee:40:40","currentApName":null,"lastApName":null,"lastSiteName":"PSL NOC"
},{
"siteEntries":{"1487056035936":{
"macAddress":"00:08:22:be:76:bb","status":"PASSERBY","siteId":1487056035936,"siteName":"PSL NOC","firstRssiTime":1488359961555,"lastRssiTime":1488360953775,"lastMarkedPasserBy":1488360953775,"firstMarkedVisitor":0,"lastMarkedVisitor":0,"firstMarkedAssociated":0,"lastMarkedAssociated":0,"lastInfoTime":0,"rssi":-81,"currentApMacAddress":"00:2a:10:ee:40:40","currentApName":null,"lastApMacAddress":"84:3d:c6:14:73:50","lastApName":null,"controller":"10.222.175.13","firstRssiTimeStamp":"2017-03-01 09:19:555","lastRssiTimeStamp":"2017-03-01 09:35:775","lastMarkedPasserByTimeStamp":"2017-03-01 09:35:775","firstMarkedVisitorTimeStamp":"null","lastMarkedVisitorTimeStamp":"null","lastMarkedAssociatedTimeStamp":"null","firstMarkedAssociatedTimeStamp":"null","lastInfoTimeStamp":"null","lastHeard":1488360953775
},"1487260407843":
….<etc>
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 229
PresenceGET: Active Clients
GET: Client DetailDescription
This API returns the client detail for the specified MAC address for a specified site.
HTTP Method
GET
Resource URI
/api/presence/v1/clients/macaddress
Requires OAuth
N
Parameters
Table 110: Parameter Details
DescriptionLocationTypeDefaultRequiredName
MAC addresspathReplaceString—Ymacaddress
Site IDpathReplaceString—Ysite-id
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/clients?siteId=<Site ID>&macaddress=<MAC address>
Sample Output[
{"siteEntries":{
"1487056035936":{"macAddress":"50:c8:e5:c5:ba:f0","status":"PASSERBY","siteId":1487056035936,"siteName":"PSL NOC","firstRssiTime":1488362139553,"lastRssiTime":1488362515548,"lastMarkedPasserBy":1488362515548,"firstMarkedVisitor":0,"lastMarkedVisitor":0,"firstMarkedAssociated":0,"lastMarkedAssociated":0,"lastInfoTime":0,"rssi":-88,"currentApMacAddress":"00:2a:10:f8:87:50",
Cisco Connected Mobile Experiences REST API Guide, Release 10.3230
PresenceGET: Client Detail
"currentApName":null,"lastApMacAddress":null,"lastApName":null,"controller":"10.222.175.13","firstRssiTimeStamp":"2017-03-01 09:55:553","lastRssiTimeStamp":"2017-03-01 10:01:548","lastMarkedPasserByTimeStamp":"2017-03-01 10:01:548","firstMarkedVisitorTimeStamp":"null","lastMarkedVisitorTimeStamp":"null","lastMarkedAssociatedTimeStamp":"null","firstMarkedAssociatedTimeStamp":"null","lastInfoTimeStamp":"null","lastHeard":1488362515548
},"1487260407843":{
"macAddress":"50:c8:e5:c5:ba:f0","status":"PASSERBY","siteId":1487260407843,"siteName":"NOC","firstRssiTime":1488362141536,"lastRssiTime":1488362513641,"lastMarkedPasserBy":1488362513641,"firstMarkedVisitor":0,"lastMarkedVisitor":0,"firstMarkedAssociated":0,"lastMarkedAssociated":0,"lastInfoTime":0,"rssi":-92,"currentApMacAddress":"84:3d:c6:0a:bb:80","currentApName":null,"lastApMacAddress":null,"lastApName":null,"controller":"10.222.175.13","firstRssiTimeStamp":"2017-03-01 09:55:536","lastRssiTimeStamp":"2017-03-01 10:01:641","lastMarkedPasserByTimeStamp":"2017-03-01 10:01:641","firstMarkedVisitorTimeStamp":"null","lastMarkedVisitorTimeStamp":"null","lastMarkedAssociatedTimeStamp":"null","firstMarkedAssociatedTimeStamp":"null","lastInfoTimeStamp":"null","lastHeard":1488362513641
}},"macAddress":"50:c8:e5:c5:ba:f0","changedOn":1488362527563,"status":"PASSERBY","ipv4Address":null,"ipv6Address":null,"ssid":null,"bytesReceived":0,"bytesSent":0,"lastSiteId":1487056035936,"currentSiteId":1487056035936,"rssi":-92,"currentSiteName":"PSL NOC","changedOnTimeStamp":"2017-03-01 10:02:563","lastApMacAddress":"00:2a:10:f8:87:50","currentApMacAddress":"00:2a:10:f8:87:50","currentApName":null,"lastApName":null,"lastSiteName":"PSL NOC"
},{
"siteEntries":{"1487056035936":{
"macAddress":"cc:61:e5:88:f0:d8","status":"PASSERBY","siteId":1487056035936,"siteName":"PSL NOC","firstRssiTime":1488360977448,"lastRssiTime":1488361771824,"lastMarkedPasserBy":1488361771824,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 231
PresenceGET: Client Detail
"firstMarkedVisitor":0,"lastMarkedVisitor":0,"firstMarkedAssociated":0,"lastMarkedAssociated":0,"lastInfoTime":0,"rssi":-84,"currentApMacAddress":"84:3d:c6:14:73:50","currentApName":null,"lastApMacAddress":"00:2a:10:f8:87:50","lastApName":null,"controller":"10.222.175.13","firstRssiTimeStamp":"2017-03-01 09:36:448","lastRssiTimeStamp":"2017-03-01 09:49:824","lastMarkedPasserByTimeStamp":"2017-03-01 09:49:824","firstMarkedVisitorTimeStamp":"null","lastMarkedVisitorTimeStamp":"null","lastMarkedAssociatedTimeStamp":"null","firstMarkedAssociatedTimeStamp":"null","lastInfoTimeStamp":"null","lastHeard":1488361771824
},"1487260407843":{
"macAddress":"cc:61:e5:88:f0:d8","status":"PASSERBY","siteId":1487260407843,"siteName":"NOC","firstRssiTime":1488361225740,"lastRssiTime":1488361589829,"lastMarkedPasserBy":1488361589829,"firstMarkedVisitor":0,"lastMarkedVisitor":0,"firstMarkedAssociated":0,"lastMarkedAssociated":0,"lastInfoTime":0,"rssi":-82,"currentApMacAddress":"84:3d:c6:0a:bb:80","currentApName":null,"lastApMacAddress":null,"lastApName":null,"controller":"10.222.175.13","firstRssiTimeStamp":"2017-03-01 09:40:740","lastRssiTimeStamp":"2017-03-01 09:46:829","lastMarkedPasserByTimeStamp":"2017-03-01 09:46:829","firstMarkedVisitorTimeStamp":"null","lastMarkedVisitorTimeStamp":"null","lastMarkedAssociatedTimeStamp":"null","firstMarkedAssociatedTimeStamp":"null","lastInfoTimeStamp":"null","lastHeard":1488361589829
}},"macAddress":"cc:61:e5:88:f0:d8","changedOn":1488361771824,"status":"PASSERBY","ipv4Address":null,"ipv6Address":null,"ssid":null,"bytesReceived":0,"bytesSent":0,"lastSiteId":1487056035936,"currentSiteId":1487056035936,"rssi":-84,"currentSiteName":"PSL NOC","changedOnTimeStamp":"2017-03-01 09:49:824","lastApMacAddress":"84:3d:c6:14:73:50","currentApMacAddress":"84:3d:c6:14:73:50","currentApName":null,"lastApName":null,"lastSiteName":"PSL NOC"
},{
"siteEntries":{"1487056035936":{
Cisco Connected Mobile Experiences REST API Guide, Release 10.3232
PresenceGET: Client Detail
"macAddress":"b4:ce:f6:6e:9d:ea","status":"PASSERBY","siteId":1487056035936,"siteName":"PSL NOC","firstRssiTime":1488357877311,"lastRssiTime":1488362333581,"lastMarkedPasserBy":1488362333581,"firstMarkedVisitor":0,"lastMarkedVisitor":0,"firstMarkedAssociated":0,"lastMarkedAssociated":0,"lastInfoTime":0,"rssi":-90,"currentApMacAddress":"00:2a:10:f8:87:50","currentApName":null,"lastApMacAddress":"84:3d:c6:14:73:50","lastApName":null,"controller":"10.222.175.13","firstRssiTimeStamp":"2017-03-01 08:44:311","lastRssiTimeStamp":"2017-03-01 09:58:581","lastMarkedPasserByTimeStamp":"2017-03-01 09:58:581","firstMarkedVisitorTimeStamp":"null","lastMarkedVisitorTimeStamp":"null","lastMarkedAssociatedTimeStamp":"null","firstMarkedAssociatedTimeStamp":"null","lastInfoTimeStamp":"null","lastHeard":1488362333581
},"1487260407843":{
"macAddress":"b4:ce:f6:6e:9d:ea","status":"PASSERBY","siteId":1487260407843,"siteName":"NOC","firstRssiTime":1488357852934,"lastRssiTime":1488362696100,"lastMarkedPasserBy":1488362696100,"firstMarkedVisitor":0,"lastMarkedVisitor":0,"firstMarkedAssociated":0,"lastMarkedAssociated":0,"lastInfoTime":0,"rssi":-95,"currentApMacAddress":"84:3d:c6:0a:bb:80","currentApName":null,"lastApMacAddress":null,"lastApName":null,"controller":"10.222.175.13","firstRssiTimeStamp":"2017-03-01 08:44:934","lastRssiTimeStamp":"2017-03-01 10:04:100","lastMarkedPasserByTimeStamp":"2017-03-01 10:04:100","firstMarkedVisitorTimeStamp":"null","lastMarkedVisitorTimeStamp":"null","lastMarkedAssociatedTimeStamp":"null","firstMarkedAssociatedTimeStamp":"null","lastInfoTimeStamp":"null","lastHeard":1488362696100
}},"macAddress":"b4:ce:f6:6e:9d:ea","changedOn":1488362696100,"status":"PASSERBY","ipv4Address":null,"ipv6Address":null,"ssid":null,"bytesReceived":0,"bytesSent":0,"lastSiteId":1487260407843,"currentSiteId":1487260407843,"rssi":-95,"currentSiteName":"NOC","changedOnTimeStamp":"2017-03-01 10:04:100","lastApMacAddress":"84:3d:c6:0a:bb:80","currentApMacAddress":"84:3d:c6:0a:bb:80",
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 233
PresenceGET: Client Detail
"currentApName":null,"lastApName":null,"lastSiteName":"NOC"
},{
"siteEntries":{"1487260407843":
Cisco Connected Mobile Experiences REST API Guide, Release 10.3234
PresenceGET: Client Detail
GET: Count of Connected Visitors for a DateDescription
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 111: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Date inyyyy-mm-ddformat
queryString—Ydate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count?siteId=<Site ID>&date=<date inyyyy-mm-dd>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 235
PresenceGET: Count of Connected Visitors for a Date
GET: Count of Connected Visitors Seen today Until NowDescription
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 112: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count/today?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3236
PresenceGET: Count of Connected Visitors Seen today Until Now
GET: Count of Connected Visitors Seen YesterdayDescription
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 113: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count/yesterday?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 237
PresenceGET: Count of Connected Visitors Seen Yesterday
GET: Average Count of Connected Visitors Seen in Last 3 DaysDescription
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 114: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count/3days?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3238
PresenceGET: Average Count of Connected Visitors Seen in Last 3 Days
GET: Average Count of Connected Visitors Seen in Last 7 DaysDescription
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 115: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count/lastweek?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 239
PresenceGET: Average Count of Connected Visitors Seen in Last 7 Days
GET: Average Count of Connected Visitors seen in last 30 DaysDescription
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 116: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count/lastmonth?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3240
PresenceGET: Average Count of Connected Visitors seen in last 30 Days
GET: Sum of Connected Visitor Counts in Last 3 daysDescription
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 117: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/total/3days?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 241
PresenceGET: Sum of Connected Visitor Counts in Last 3 days
GET: Sum of Connected Visitor Counts in Last 7 daysDescription
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 118: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/total/lastweek?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3242
PresenceGET: Sum of Connected Visitor Counts in Last 7 days
GET: Sum of Connected Visitor Counts in Last 30 daysDescription
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 119: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/total/lastmonth?siteId=<Site ID>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 243
PresenceGET: Sum of Connected Visitor Counts in Last 30 days
GET: Sum of Connected Visitor Counts in the Specified DateRange
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 120: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/total/?siteId=<Site ID>&startDate=<date inyyyy-mm-dd>&endDate=<date in yyyy-mm-dd>
Sample Output
Number
Cisco Connected Mobile Experiences REST API Guide, Release 10.3244
PresenceGET: Sum of Connected Visitor Counts in the Specified Date Range
GET: Hourly Count of Connected Visitors TodayDescription
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 121: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/hourly/today/?siteId=<Site ID>
Sample Output{
"0":0,"1":0,"2":0,"3":0,"4":0,"5":0,"6":0,"7":0,"8":0,"9":0
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 245
PresenceGET: Hourly Count of Connected Visitors Today
GET: Hourly Count of Connected Visitors YesterdayDescription
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 122: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/hourly/yesterday/?siteId=<Site ID>
Sample Output{
"0":0,"1":0,"2":0,"3":0,"4":0,"5":0,"6":0,"7":0,"8":0,"9":0
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3246
PresenceGET: Hourly Count of Connected Visitors Yesterday
GET: Hourly Count of Connected Visitors in Last 3 DaysDescription
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 123: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IdqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 247
PresenceGET: Hourly Count of Connected Visitors in Last 3 Days
GET: Hourly Count of Connected Visitors for the Specified DayDescription
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 124: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IdqueryNumber—YsiteId
DatequeryString—Ndate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/hourly/?siteId=<Site ID>&date=<date inyyyy-mm-dd>
Sample Output{
"0":0,"1":0,"2":0,"3":0,"4":0,"5":0,"6":0,"7":0,"8":0,"9":0
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3248
PresenceGET: Hourly Count of Connected Visitors for the Specified Day
GET: Daily Count of Connected Visitors for the Specified DateRange
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 125: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/daily/?siteId=<Site ID>&startDate=<date inyyyy-mm-dd>&endDate=<date in yyyy-mm-dd>
Sample Output{
"2017-03-01":0,"2017-03-02":0,"2017-03-03":0,"2017-03-04":0,"2017-03-05":0,"2017-03-06":0,"2017-03-07":0,"2017-03-08":0,"2017-03-09":0,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 249
PresenceGET: Daily Count of Connected Visitors for the Specified Date Range
"2017-03-10":0}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3250
PresenceGET: Daily Count of Connected Visitors for the Specified Date Range
GET: Daily Count of Connected Visitors for Last 7 daysDescription
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 126: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 251
PresenceGET: Daily Count of Connected Visitors for Last 7 days
GET: Daily Count of Connected Visitors for last 30 DaysDescription
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 127: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3252
PresenceGET: Daily Count of Connected Visitors for last 30 Days
GET: Daily Count of Connected Visitors by Hour for the SpecifiedDate 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 128: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/daily/hourcategory/?siteId=<SiteID>&startDate=<date in yyyy-mm-dd>&endDate=<date in yyyy-mm-dd>
Sample Output{
"2017-03-01":{"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-02":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 253
PresenceGET: Daily Count of Connected Visitors by Hour for the Specified Date Range
"2017-03-03":{"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-04":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-05":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-06":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-07":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-08":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-09":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-10":{
"business_hours":null,"evening_hours":null,"morning_hours":null
}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3254
PresenceGET: Daily Count of Connected Visitors by Hour for the Specified Date Range
GET: Site KPI Summary for Specified Date or Date RangeDescription
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 129: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ndate
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/kpisummary?siteId=<Site ID>&startDate=<date inyyyy-mm-dd>&endDate=<date in yyyy-mm-dd>
Sample Output{
"visitorCount":107,"totalPasserbyCount":0,"totalVisitorCount":100,"totalConnectedCount":0,"connectedPercentage":0,"conversionRate":100,"averageDwell":0.0,"averageDwellByLevels":{
"FIVE_TO_THIRTY_MINUTES":{"average":0.0,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 255
PresenceGET: Site KPI Summary for Specified Date or Date Range
"count":0},"THIRTY_TO_SIXTY_MINUTES":{
"average":0.0,"count":0
},"ONE_TO_FIVE_HOURS":{
"average":0.0,"count":0
},"FIVE_TO_EIGHT_HOURS":{
"average":0.0,"count":0
},"EIGHT_PLUS_HOURS":{
"average":0.0,"count":0
}},"topManufacturers":null,"peakSummary":null,"peakWeekSummary":{
"peakHour":15,"peakDate":"2017-02-28","peakWeek":0,"interval":"WEEK","peakHourCount":49,"averageHourlyCount":25.0138888888889,"hourlyCounts":{
"0":13,"1":13,"2":12,"3":11,"4":12,"5":13,"6":13,"7":15,"8":14,"9":15,"10":21,"11":26,"12":29,"13":31,"14":38,"15":44,"16":46,"17":41,"18":44,"19":38,"20":32,"21":28,"22":25,"23":25
},"maxHour":15,"maxDay":1,"peakDayCount":112,"peakHourDay":"2017-02-27"
},"peakMonthSummary":{
"peakHour":16,"peakDate":"2017-03-01","peakWeek":9,"interval":"MONTH","peakHourCount":45,"averageHourlyCount":25.5,"hourlyCounts":{
"0":20,"1":18,"2":14,"3":13,"4":14,"5":17,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3256
PresenceGET: Site KPI Summary for Specified Date or Date Range
"6":18,"7":18,"8":19,"9":15,"10":23,"11":22,"12":31,"13":28,"14":37,"15":41,"16":45,"17":43,"18":42,"19":33,"20":29,"21":28,"22":26,"23":18
},"maxHour":16,"maxDay":3,"peakDayCount":100,"peakHourDay":"2017-03-01"
}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 257
PresenceGET: Site KPI Summary for Specified Date or Date Range
GET: Site KPI Summary for TodayDescription
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 130: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3258
PresenceGET: Site KPI Summary for Today
GET: Site KPI Summary for YesterdayDescription
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 131: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 259
PresenceGET: Site KPI Summary for Yesterday
GET: Site KPI Summary for Last 3 DaysDescription
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 132: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3260
PresenceGET: Site KPI Summary for Last 3 Days
GET: Site KPI Summary for last 7 daysDescription
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 133: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 261
PresenceGET: Site KPI Summary for last 7 days
GET: Site KPI Summary for Last 30 DaysDescription
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 134: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3262
PresenceGET: Site KPI Summary for Last 30 Days
GET: Site Insights for Specified Date or Date RangeDescription
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 135: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ndate
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/insights/?siteId=<Site ID>&startDate=<date inyyyy-mm-dd>&endDate=<date in yyyy-mm-dd>
Sample Output{
"weekStatus":null,"monthStatus":null,"yesterdayStatus":null,"weekStats":{
"peakDay":"2017-02-28","busiestHour":0,"peakCount":112,"busiestDay":0,"hourlyAverage":25.0138888888889,"peakHour":15,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 263
PresenceGET: Site Insights for Specified Date or Date Range
"peakHourCount":49,"peakHourDay":"2017-02-27","busiestWeekDate":"2017-03-01","busiestMonthDate":null
},"monthStats":{
"peakDay":"2017-03-01","busiestHour":16,"peakCount":100,"busiestDay":3,"hourlyAverage":25.5,"peakHour":16,"peakHourCount":45,"peakHourDay":"2017-03-01","busiestWeekDate":null,"busiestMonthDate":"2017-03-01"
},"weekRepeatVisitorStats":{
"DAILY":{"peakDay":"2017-03-01","busiestHour":0,"peakCount":60,"busiestDay":-1,"hourlyAverage":14.6111111111111,"peakHour":18,"peakHourCount":34,"peakHourDay":null,"busiestWeekDate":null,"busiestMonthDate":null
},"WEEKLY":{
"peakDay":"2017-02-27","busiestHour":16,"peakCount":27,"busiestDay":-1,"hourlyAverage":5.375,"peakHour":16,"peakHourCount":19,"peakHourDay":null,"busiestWeekDate":null,"busiestMonthDate":null
},"OCCASIONAL":{
"peakDay":"2017-02-28","busiestHour":0,"peakCount":20,"busiestDay":-1,"hourlyAverage":2.44444444444444,"peakHour":19,"peakHourCount":6,"peakHourDay":null,"busiestWeekDate":null,"busiestMonthDate":null
},"FIRST_TIME":{
"peakDay":"2017-02-27","busiestHour":0,"peakCount":24,"busiestDay":-1,"hourlyAverage":1.88888888888889,"peakHour":15,"peakHourCount":6,"peakHourDay":null,"busiestWeekDate":null,"busiestMonthDate":null
},"YESTERDAY":{
"peakDay":null,"busiestHour":0,"peakCount":0,"busiestDay":0,"hourlyAverage":0.0,"peakHour":0,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3264
PresenceGET: Site Insights for Specified Date or Date Range
"peakHourCount":0,"peakHourDay":null,"busiestWeekDate":null,"busiestMonthDate":null
}},"monthRepeatVisitorStats":{
"DAILY":{"peakDay":"2017-03-01","busiestHour":18,"peakCount":60,"busiestDay":-1,"hourlyAverage":18.4166666666667,"peakHour":18,"peakHourCount":34,"peakHourDay":null,"busiestWeekDate":null,"busiestMonthDate":null
},"WEEKLY":{
"peakDay":"2017-03-01","busiestHour":22,"peakCount":18,"busiestDay":-1,"hourlyAverage":3.75,"peakHour":22,"peakHourCount":6,"peakHourDay":null,"busiestWeekDate":null,"busiestMonthDate":null
},"OCCASIONAL":{
"peakDay":"2017-03-01","busiestHour":7,"peakCount":8,"busiestDay":-1,"hourlyAverage":1.83333333333333,"peakHour":7,"peakHourCount":4,"peakHourDay":null,"busiestWeekDate":null,"busiestMonthDate":null
},"FIRST_TIME":{
"peakDay":"2017-03-01","busiestHour":16,"peakCount":14,"busiestDay":-1,"hourlyAverage":1.5,"peakHour":16,"peakHourCount":5,"peakHourDay":null,"busiestWeekDate":null,"busiestMonthDate":null
},"YESTERDAY":{
"peakDay":null,"busiestHour":0,"peakCount":0,"busiestDay":0,"hourlyAverage":0.0,"peakHour":0,"peakHourCount":0,"peakHourDay":null,"busiestWeekDate":null,"busiestMonthDate":null
}}
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 265
PresenceGET: Site Insights for Specified Date or Date Range
GET: Average Count of Repeat Visitors for Last 7 DaysDescription
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 136: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3266
PresenceGET: Average Count of Repeat Visitors for Last 7 Days
GET: Average Count of Repeat Visitors for Last 30 daysDescription
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 137: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 267
PresenceGET: Average Count of Repeat Visitors for Last 30 days
GET: Sum of Repeat Visitor Counts for Last 3 daysDescription
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 138: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3268
PresenceGET: Sum of Repeat Visitor Counts for Last 3 days
GET: Sum of Repeat Visitor Counts for Last 7 daysDescription
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 139: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 269
PresenceGET: Sum of Repeat Visitor Counts for Last 7 days
GET: Sum of Repeat Visitor Counts for Last 30 daysDescription
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 140: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3270
PresenceGET: Sum of Repeat Visitor Counts for Last 30 days
GET: Hourly Count of Repeat Visitors for a DayDescription
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 141: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ydate
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 271
PresenceGET: Hourly Count of Repeat Visitors for a Day
GET: Hourly Count of Repeat Visitors TodayDescription
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 142: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3272
PresenceGET: Hourly Count of Repeat Visitors Today
GET: Hourly Count of Repeat Visitors YesterdayDescription
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 143: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 273
PresenceGET: Hourly Count of Repeat Visitors Yesterday
GET: Count of Repeat Visitors for a Date or Date RangeDescription
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 144: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ydate
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/repeatvisitors/count/?siteId=<Site ID>&startDate=<datein yyyy-mm-dd>&endDate=<date in yyyy-mm-dd>
Sample Output{
"DAILY":0,"WEEKLY":0,"OCCASIONAL":0,"FIRST_TIME":0,"YESTERDAY":0
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3274
PresenceGET: Count of Repeat Visitors for a Date or Date Range
GET: Count of Repeat Visitors for TodayDescription
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 145: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 275
PresenceGET: Count of Repeat Visitors for Today
GET: Count of Repeat Visitors for YesterdayDescription
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 146: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3276
PresenceGET: Count of Repeat Visitors for Yesterday
GET: Average Count of Repeat Visitors for Last 3 daysDescription
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 147: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 277
PresenceGET: Average Count of Repeat Visitors for Last 3 days
GET: Average Count of Repeat Visitors for Specified Date RangeDescription
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 148: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/repeatvisitors/average/?siteId=<Site ID>&startDate=<datein yyyy-mm-dd>&endDate=<date in yyyy-mm-dd>
Sample Output{
"DAILY":0,"WEEKLY":0,"OCCASIONAL":0,"FIRST_TIME":0,"YESTERDAY":0
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3278
PresenceGET: Average Count of Repeat Visitors for Specified Date Range
GET: Hourly Count of Repeat Visitors for Last 3 DaysDescription
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 149: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 279
PresenceGET: Hourly Count of Repeat Visitors for Last 3 Days
GET: Repeat Visitor Summary for a DayDescription
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 150: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ydate
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3280
PresenceGET: Repeat Visitor Summary for a Day
GET: Repeat Visitor Summary for a WeekDescription
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 151: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ydate
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 281
PresenceGET: Repeat Visitor Summary for a Week
GET: Repeat Visitor Summary for a MonthDescription
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 152: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ydate
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3282
PresenceGET: Repeat Visitor Summary for a Month
GET: Daily Count of Repeat Visitors for Specified Date RangeDescription
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 153: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/repeatvisitors/daily/?siteId=<Site ID>&startDate=<datein yyyy-mm-dd>&endDate=<date in yyyy-mm-dd>
Sample Output{
"2017-03-01":null,"2017-03-02":null,"2017-03-03":null,"2017-03-04":null,"2017-03-05":null,"2017-03-06":null,"2017-03-07":null,"2017-03-08":null,"2017-03-09":null,"2017-03-10":{
"DAILY":0,"WEEKLY":0,"OCCASIONAL":0,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 283
PresenceGET: Daily Count of Repeat Visitors for Specified Date Range
"FIRST_TIME":0,"YESTERDAY":0
}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3284
PresenceGET: Daily Count of Repeat Visitors for Specified Date Range
GET: Daily Count of Repeat Visitors for Last 7 DaysDescription
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 154: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 285
PresenceGET: Daily Count of Repeat Visitors for Last 7 Days
GET: Daily Count of Repeat Visitors for Last 30 daysDescription
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 155: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3286
PresenceGET: Daily Count of Repeat Visitors for Last 30 days
GET: Peak Hour of Visitors TodayDescription
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 156: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 287
PresenceGET: Peak Hour of Visitors Today
GET: Count of Visitors TodayDescription
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 157: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3288
PresenceGET: Count of Visitors Today
GET: Count of Visitors YesterdayDescription
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 158: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 289
PresenceGET: Count of Visitors Yesterday
GET: Count of Unique Visitors for Last 3 DaysDescription
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 159: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3290
PresenceGET: Count of Unique Visitors for Last 3 Days
GET: Count of Unique Visitors for Last WeekDescription
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 160: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 291
PresenceGET: Count of Unique Visitors for Last Week
GET: Count of Unique Visitors for Last MonthDescription
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 161: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3292
PresenceGET: Count of Unique Visitors for Last Month
GET: Count of Unique Visitors for a Date/Date RangeDescription
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 162: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start DatequeryString—YstartDate
End DatequeryString—YendDate
DatequeryString—Ndate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/visitor/count/?siteId=<Site ID>&date=<date inyyyy-mm-dd>
Sample Output107
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 293
PresenceGET: Count of Unique Visitors for a Date/Date Range
GET: Sum of Visitor Counts for a Date RangeDescription
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 163: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start datequeryString—YstartDate
End datequeryString—YendDate
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3294
PresenceGET: Sum of Visitor Counts for a Date Range
GET: Sum of Visitor Counts for the Last 3 DaysDescription
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 164: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 295
PresenceGET: Sum of Visitor Counts for the Last 3 Days
GET: Sum of Visitor Counts for the Last WeekDescription
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 165: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3296
PresenceGET: Sum of Visitor Counts for the Last Week
GET: Sum of Visitor Counts for the Last MonthDescription
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 166: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 297
PresenceGET: Sum of Visitor Counts for the Last Month
GET: Hourly Count of Visitors TodayDescription
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 167: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3298
PresenceGET: Hourly Count of Visitors Today
GET: Hourly Count of Visitors YesterdayDescription
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 168: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IdqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 299
PresenceGET: Hourly Count of Visitors Yesterday
GET: Hourly Count of Visitors for Last 3 DaysDescription
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 169: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IdqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3300
PresenceGET: Hourly Count of Visitors for Last 3 Days
GET: Hourly Count of Visitors for a DayDescription
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 170: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IdqueryNumber—YsiteId
DatequeryString—Ydate
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 301
PresenceGET: Hourly Count of Visitors for a Day
GET: Daily Count of Visitors for a Date RangeDescription
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 171: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IdqueryNumber—YsiteId
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/hourly/?siteId=<Site ID>&date=<date inyyyy-mm-dd>
Sample Output{
"0":0,"1":0,"2":0,"3":0,"4":0,"5":0,"6":0,"7":0,"8":0,"9":0
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3302
PresenceGET: Daily Count of Visitors for a Date Range
GET: Daily Count of Visitors for Last WeekDescription
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 172: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 303
PresenceGET: Daily Count of Visitors for Last Week
GET: Daily Count of Visitors for Last MonthDescription
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 173: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3304
PresenceGET: Daily Count of Visitors for Last Month
GET: Daily Count of Visitors by Hour Category for a Date RangeDescription
This API returns the daily count of visitors seen during morning, business, evening hours for the specifieddate range.
HTTP Method
GET
Resource URI
/api/presence/v1/visitor/daily/hourcategory
Requires OAuth
N
Parameters
Table 174: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/visitor/daily/hourcategory/?siteId=<Site ID>&date=<datein yyyy-mm-dd>
Sample Output{
"2017-03-01":{"business_hours":0,"evening_hours":0,"morning_hours":0
},"2017-03-02":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-03":{
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 305
PresenceGET: Daily Count of Visitors by Hour Category for a Date Range
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-04":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-05":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-06":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-07":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-08":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-09":{
"business_hours":null,"evening_hours":null,"morning_hours":null
},"2017-03-10":{
"business_hours":null,"evening_hours":null,"morning_hours":null
}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3306
PresenceGET: Daily Count of Visitors by Hour Category for a Date Range
GET: Visitor Summary for a DayDescription
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 175: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ydate
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 307
PresenceGET: Visitor Summary for a Day
GET: Visitor Summary for WeekDescription
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 176: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ydate
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3308
PresenceGET: Visitor Summary for Week
GET: Visitor Summary for MonthDescription
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 177: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ydate
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 309
PresenceGET: Visitor Summary for Month
GET: Count of Visitors by Dwell Level for a Date or Date RangeDescription
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 178: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ydate
Start DatequeryString—YstartDate
End DatequeryString—NendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/dwell/count/?siteId=<Site ID>&date=<date inyyyy-mm-dd>
Sample Output{
"FIVE_TO_THIRTY_MINUTES":0,"THIRTY_TO_SIXTY_MINUTES":0,"ONE_TO_FIVE_HOURS":0,"FIVE_TO_EIGHT_HOURS":0,"EIGHT_PLUS_HOURS":0
}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3310
PresenceGET: Count of Visitors by Dwell Level for a Date or Date Range
GET: Count of Visitors by Dwell Level for TodayDescription
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 179: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 311
PresenceGET: Count of Visitors by Dwell Level for Today
GET: Count of Visitors by Dwell Level for YesterdayDescription
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 180: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3312
PresenceGET: Count of Visitors by Dwell Level for Yesterday
GET: Count of Visitors by Dwell Level for Last 3 DaysDescription
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 181: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 313
PresenceGET: Count of Visitors by Dwell Level for Last 3 Days
GET: Count of Visitors by Dwell Level for Last 7 DaysDescription
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 182: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3314
PresenceGET: Count of Visitors by Dwell Level for Last 7 Days
GET: Count of Visitors by Dwell Level for Last 30 DaysDescription
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 183: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 315
PresenceGET: Count of Visitors by Dwell Level for Last 30 Days
GET: Average Count of Visitors by Dwell Level for Last 7 DaysDescription
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 184: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3316
PresenceGET: Average Count of Visitors by Dwell Level for Last 7 Days
GET: Average Count of Visitors by Dwell Level for Last 30 DaysDescription
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 185: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 317
PresenceGET: Average Count of Visitors by Dwell Level for Last 30 Days
GET: Hourly Count of Visitors by Dwell Level for a Specific DayDescription
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 186: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ydate
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3318
PresenceGET: Hourly Count of Visitors by Dwell Level for a Specific Day
GET: Hourly Count of Visitors by Dwell Level for TodayDescription
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 187: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 319
PresenceGET: Hourly Count of Visitors by Dwell Level for Today
GET: Average Visitor Dwell Time by Dwell Level for Last 7 DaysDescription
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 188: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3320
PresenceGET: Average Visitor Dwell Time by Dwell Level for Last 7 Days
GET: Average Visitor Dwell Time by Dwell Level for Last 30 DaysDescription
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 189: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 321
PresenceGET: Average Visitor Dwell Time by Dwell Level for Last 30 Days
GET: Daily Average Visitor Dwell Time by Dwell Level for aSpecific Date Range
Description
This API returns the daily average visitor dwell time in minutes categorized by dwell level for the specifieddate range.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/dailyaverage
Requires OAuth
N
Parameters
Table 190: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/dwell/dailyaverage/?siteId=<Site ID>&date=<date inyyyy-mm-dd>
Sample Output{
"2017-03-01":null,"2017-03-02":null,"2017-03-03":null,"2017-03-04":null,"2017-03-05":null,"2017-03-06":null,"2017-03-07":null,"2017-03-08":null,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3322
PresenceGET: Daily Average Visitor Dwell Time by Dwell Level for a Specific Date Range
"2017-03-09":null,"2017-03-10":{
"FIVE_TO_THIRTY_MINUTES":0.0,"THIRTY_TO_SIXTY_MINUTES":0.0,"ONE_TO_FIVE_HOURS":0.0,"FIVE_TO_EIGHT_HOURS":0.0,"EIGHT_PLUS_HOURS":0.0
}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 323
PresenceGET: Daily Average Visitor Dwell Time by Dwell Level for a Specific Date Range
GET: Daily Average Visitor Dwell Time by Dwell Level for Last7 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 191: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3324
PresenceGET: Daily Average Visitor Dwell Time by Dwell Level for Last 7 Days
GET: Daily Average Visitor Dwell Time by Dwell Level for Last30 Days
Description
This API returns the daily average visitor dwell time in minutes categorized by dwell level for the last 30days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/dailyaverage/lastmonth
Requires OAuth
N
Parameters
Table 192: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 325
PresenceGET: Daily Average Visitor Dwell Time by Dwell Level for Last 30 Days
GET: Hourly Count of Visitors by Dwell level for YesterdayDescription
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 193: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IdqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3326
PresenceGET: Hourly Count of Visitors by Dwell level for Yesterday
GET: Hourly Count of Visitors by Dwell Level for Last 3 DaysDescription
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 194: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 327
PresenceGET: Hourly Count of Visitors by Dwell Level for Last 3 Days
GET: Daily Count of Visitors by Dwell Level for a Specific DateRange
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 195: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start DatequeryString—YstartDate
End DatequeryString—YendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/dwell/daily/?siteId=<Site ID>&date=<date inyyyy-mm-dd>
Sample Output{
"2017-03-01":{"FIVE_TO_THIRTY_MINUTES":0,"THIRTY_TO_SIXTY_MINUTES":0,"ONE_TO_FIVE_HOURS":0,"FIVE_TO_EIGHT_HOURS":0,"EIGHT_PLUS_HOURS":0
},"2017-03-02":{
"FIVE_TO_THIRTY_MINUTES":0,"THIRTY_TO_SIXTY_MINUTES":0,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3328
PresenceGET: Daily Count of Visitors by Dwell Level for a Specific Date Range
"ONE_TO_FIVE_HOURS":0,"FIVE_TO_EIGHT_HOURS":0,"EIGHT_PLUS_HOURS":0
},"2017-03-03":{
"FIVE_TO_THIRTY_MINUTES":0,"THIRTY_TO_SIXTY_MINUTES":0,"ONE_TO_FIVE_HOURS":0,"FIVE_TO_EIGHT_HOURS":0,"EIGHT_PLUS_HOURS":0
},"2017-03-04":{
"FIVE_TO_THIRTY_MINUTES":0,"THIRTY_TO_SIXTY_MINUTES":0,"ONE_TO_FIVE_HOURS":0,"FIVE_TO_EIGHT_HOURS":0,"EIGHT_PLUS_HOURS":0
},"2017-03-05":{
"FIVE_TO_THIRTY_MINUTES":0,"THIRTY_TO_SIXTY_MINUTES":0,"ONE_TO_FIVE_HOURS":0,"FIVE_TO_EIGHT_HOURS":0,"EIGHT_PLUS_HOURS":0
},"2017-03-06":{
"FIVE_TO_THIRTY_MINUTES":0,"THIRTY_TO_SIXTY_MINUTES":0,"ONE_TO_FIVE_HOURS":0,"FIVE_TO_EIGHT_HOURS":0,"EIGHT_PLUS_HOURS":0
},"2017-03-07":{
"FIVE_TO_THIRTY_MINUTES":0,"THIRTY_TO_SIXTY_MINUTES":0,"ONE_TO_FIVE_HOURS":0,"FIVE_TO_EIGHT_HOURS":0,"EIGHT_PLUS_HOURS":0
},"2017-03-08":{
"FIVE_TO_THIRTY_MINUTES":0,"THIRTY_TO_SIXTY_MINUTES":0,"ONE_TO_FIVE_HOURS":0,"FIVE_TO_EIGHT_HOURS":0,"EIGHT_PLUS_HOURS":0
},"2017-03-09":{
"FIVE_TO_THIRTY_MINUTES":0,"THIRTY_TO_SIXTY_MINUTES":0,"ONE_TO_FIVE_HOURS":0,"FIVE_TO_EIGHT_HOURS":0,"EIGHT_PLUS_HOURS":0
},"2017-03-10":{
"FIVE_TO_THIRTY_MINUTES":0,"THIRTY_TO_SIXTY_MINUTES":0,"ONE_TO_FIVE_HOURS":0,"FIVE_TO_EIGHT_HOURS":0,"EIGHT_PLUS_HOURS":0
}}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 329
PresenceGET: Daily Count of Visitors by Dwell Level for a Specific Date Range
GET: Daily Count of Visitors by Dwell Level for Last 7 DaysDescription
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 196: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3330
PresenceGET: Daily Count of Visitors by Dwell Level for Last 7 Days
GET: Daily Count of Visitors by Dwell Level for Last 30 DaysDescription
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 197: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 331
PresenceGET: Daily Count of Visitors by Dwell Level for Last 30 Days
GET: Average Visitor Dwell Time for the Specific Date or DateRange
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 198: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Start DatequeryString—YstartDate
End DatequeryString—YendDate
DatequeryString—Ndate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/dwell/average/?siteId=<Site ID>&date=<date inyyyy-mm-dd>
Sample Output0.0
Cisco Connected Mobile Experiences REST API Guide, Release 10.3332
PresenceGET: Average Visitor Dwell Time for the Specific Date or Date Range
GET: Average Visitor Dwell Time for TodayDescription
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 199: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 333
PresenceGET: Average Visitor Dwell Time for Today
GET: Average Visitor Dwell Time for YesterdayDescription
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 200: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3334
PresenceGET: Average Visitor Dwell Time for Yesterday
GET: Average Visitor Dwell Time for Last 3 DaysDescription
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 201: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 335
PresenceGET: Average Visitor Dwell Time for Last 3 Days
GET: Average Visitor Dwell Time for Last 7 DaysDescription
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 202: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3336
PresenceGET: Average Visitor Dwell Time for Last 7 Days
GET: Average Visitor Dwell Time for Last 30 DaysDescription
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 203: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 337
PresenceGET: Average Visitor Dwell Time for Last 30 Days
GET: Average Visitor Dwell Time by Dwell Level for a SpecificDate or Date Range
Description
This API returns the average visitor dwell time in minutes categorized by dwell level for the specified dateor date range.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagebylevel
Requires OAuth
N
Parameters
Table 204: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
DatequeryString—Ydate
Start DatequeryString—YstartDate
End DatequeryString—NendDate
Content Type
application/json
Usage Guidelines https://<tenant-id>.cmxcisco.com/api/presence/v1/dwell/averagebylevel/?siteId=<Site ID>&date=<date inyyyy-mm-dd>
Sample Output{
"FIVE_TO_THIRTY_MINUTES":0.0,"THIRTY_TO_SIXTY_MINUTES":0.0,"ONE_TO_FIVE_HOURS":0.0,"FIVE_TO_EIGHT_HOURS":0.0,
Cisco Connected Mobile Experiences REST API Guide, Release 10.3338
PresenceGET: Average Visitor Dwell Time by Dwell Level for a Specific Date or Date Range
"EIGHT_PLUS_HOURS":0.0}
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 339
PresenceGET: Average Visitor Dwell Time by Dwell Level for a Specific Date or Date Range
GET: Average Visitor Dwell Time by Dwell Level for TodayDescription
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 205: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3340
PresenceGET: Average Visitor Dwell Time by Dwell Level for Today
GET: Average Visitor Dwell Time by Dwell Level for YesterdayDescription
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 206: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3 341
PresenceGET: Average Visitor Dwell Time by Dwell Level for Yesterday
GET: Average Visitor Dwell Time by Dwell Level for Last 3 daysDescription
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 207: Parameter Details
DescriptionLocationTypeDefaultRequiredName
Site IDqueryNumber—YsiteId
Content Type
application/json
Cisco Connected Mobile Experiences REST API Guide, Release 10.3342
PresenceGET: Average Visitor Dwell Time by Dwell Level for Last 3 days