Professional Documents
Culture Documents
B CMX 102 API Reference
B CMX 102 API Reference
2
First Published: April 21, 2015
Last Modified: March 31, 2016
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version
of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://
www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)
2015
CONTENTS
CHAPTER 1
Preface 1
Audience 1
Conventions 1
Related Documentation 2
Obtaining Documentation and Submitting a Service Request 2
CHAPTER 2
Analytics 3
GET: Summary of Count of SMA 4
GET: Details of SMA Count with Summary Type 6
GET: All Summary Count of SMA with Hashtags 8
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas 10
POST: Paths for a Given Period and Areas 14
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas 16
GET: All summary KPI 20
GET: Specific set of Summary KPIs or a list of available ones 21
POST: Breakdown of Connected and Detected Devices for a Given Period and Areas 22
GET: Alerts for Device Count for a single Heterarchy Element and Time Frame 25
GET: Alerts for Device Count for a single Heterarchy Element 26
GET: Retrieves Alerts for Device Count 27
POST: Queue Time for a Given Period and Areas 28
POST: Overview Data for Target Areas for Brochure View 31
POST: Dwell Time for a Given Period and Areas 34
POST: Device Count for a Given Period and Areas 38
CHAPTER 3
Configuration 43
GET: Get Supported Northbound Notifications 46
GET: Current CMX Image Version 47
GET: Count of Active Alerts 48
Contents
Contents
CHAPTER 4
Connect 113
GET: Query User Sessions 114
CHAPTER 5
Location 117
GET: Active Tags Count 118
GET: All Tags 119
GET: Tag by MAC Address 120
GET: Supported Northbound Notifications 121
GET: Count of all the Beacons 122
PUT: Place a Beacon at Detected Location on Map 123
PUT: Updates Name of a Given Beacon 124
Contents
CHAPTER 6
Presence 145
GET: Count of Passersby Today 149
GET: Count of Passersby Yesterday 150
GET: Average Count of Passersby in Last 3 Days 151
GET: Average Count of Passersby in the Last 7 days 152
GET: Average Count of Passersby in the Last 30 Days 153
GET: Sum of Passerby Counts in the Specified Date Range 154
GET: Sum of Passerby Counts in the Last 3 Days 155
GET: Sum of Passerby Counts in the Last 7 Days 156
GET: Count of Passersby on a Given Date 157
GET: Sum of Passerby Counts in the Last 30 days 158
GET: Hourly Count of Passersby Today 159
GET: Hourly Count of Passersby Yesterday 160
GET: Hourly Count of Passersby for Last 3 days 161
GET: Hourly Count of Passersby for a Day 162
GET: Daily Count of Passersby for a Specified Date Range 163
GET: Daily Count of Passersby for the Last 7 days 164
Contents
Contents
Contents
Contents
Preface
Audience, page 1
Conventions, page 1
Related Documentation, page 2
Obtaining Documentation and Submitting a Service Request, page 2
Audience
This document is for network administrators who configure Cisco Connected Mobile Experiences (Cisco
CMX) services.
Conventions
This document uses the following conventions:
Table 1: Conventions
Convention
Indication
bold font
italic font
Document titles, new or emphasized terms, and arguments for which you supply
values are in italic font.
[]
{x | y | z }
[x|y|z]
string
A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.
courier
font
Terminal sessions and information the system displays appear in courier font.
Preface
Related Documentation
Note
Tip
Caution
Convention
Indication
<>
[]
!, #
An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.
Means reader take note. Notes contain helpful suggestions or references to material not covered in the
manual.
Means reader be careful. In this situation, you might perform an action that could result in equipment
damage or loss of data.
Related Documentation
For more information about Cisco Mobility Services Engine and related products, see:
http://www.cisco.com/c/en/us/support/wireless/mobility-services-engine/tsd-products-support-series-h
For more information about Cisco Connected Mobile Experiences (Cisco CMX), see:
http://www.cisco.com/c/en/us/solutions/enterprise-networks/connected-mobile-experiences/index.html
Analytics
GET: Summary of Count of SMA, page 4
GET: Details of SMA Count with Summary Type, page 6
GET: All Summary Count of SMA with Hashtags, page 8
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas, page 10
POST: Paths for a Given Period and Areas, page 14
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas, page 16
GET: All summary KPI, page 20
GET: Specific set of Summary KPIs or a list of available ones, page 21
POST: Breakdown of Connected and Detected Devices for a Given Period and Areas, page 22
GET: Alerts for Device Count for a single Heterarchy Element and Time Frame, page 25
GET: Alerts for Device Count for a single Heterarchy Element, page 26
GET: Retrieves Alerts for Device Count, page 27
POST: Queue Time for a Given Period and Areas, page 28
POST: Overview Data for Target Areas for Brochure View, page 31
POST: Dwell Time for a Given Period and Areas, page 34
POST: Device Count for a Given Period and Areas, page 38
Analytics
GET: Summary of Count of SMA
Name
Required
Default
Type
Location
Description
location
String
query
dailyHours
String
query
Analytics
GET: Summary of Count of SMA
Name
Required
Default
Type
Location
Description
period
String
query
Content Type
application or json
Analytics
GET: Details of SMA Count with Summary Type
Name
Required
Default
Type
Location
Description
location
String
query
dailyHours
String
query
Analytics
GET: Details of SMA Count with Summary Type
Name
Required
Default
Type
Location
Description
period
String
query
summaryType
String
query
Content Type
application/json
Analytics
GET: All Summary Count of SMA with Hashtags
Name
Required
Default
Type
Location
Description
location
String
query
period
String
query
Analytics
GET: All Summary Count of SMA with Hashtags
Content Type
application/json
Analytics
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
Description
granularity
Allowable Values/Formats
hourly
daily
weekly
monthly
yearly
tag
tag-name
heterarchy level. One can
limit to top n results (that is,
the n values with highest
count) by adding [n], or the
n bottom results by adding
[n]
Analytics
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
Description
period
Allowable Values/Formats
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
forever
timeRange
aggregate
HH:mm-HH:mm
now
none
sum
avg
areas
durationCategories
includeStationary
connectionState
connected
detected
all
Analytics
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
Description
Allowable Values/Formats
percentageOf
Heirarchy level
dwellLimits
areaFilter
default
minute
comma separated limit
label:limit value
descendantOf
subsetOf:comma separated
ids
true
false
HTTP Method
POST
Resource URI
/api/analytics/v1/dwellBreakdown
Analytics
POST: Breakdown of Dwell Times Spent by Devices for a Given Period and Areas
Requires OAuth
N
Parameters
Table 6: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Content Type
application/json
Analytics
POST: Paths for a Given Period and Areas
Description
period
Allowable values/formats
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
forever
timeRange
now
targetArea
allAreas
granularity
Heirarchy level
durationCategories
HH:mm-HH:mm
Analytics
POST: Paths for a Given Period and Areas
HTTP Method
POST
Resource URI
/api/analytics/v1/path
Requires OAuth
N
Parameters
Table 8: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Content Type
application/json
Analytics
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas
Description
granularity
Allowable values/formats
hourly
daily
weekly
monthly
yearly
tag
tag-name
heterarchy level
null
period
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
Analytics
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas
Description
yAxis
timeRange
aggregate
Allowable values/formats
absoluteDevices
absoluteVisits
HH:mm-HH:mm
now
none
sum
avg
areas
durationCategories
includeStationary
connectionState
connected
detected
all
percentageOf
heterarchy level
Analytics
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas
Description
Allowable values/formats
areaFilter
descendantOf
subsetOf:comma separated
ids
true
false
HTTP Method
POST
Resource URI
/api/analytics/v1/manufacturers
Requires OAuth
N
Parameters
Table 10: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Analytics
POST: Retrieve a Breakdown of Manufacturers for a Given Period and Areas
Content Type
application/json
Analytics
GET: All summary KPI
Analytics
GET: Specific set of Summary KPIs or a list of available ones
Name
Required
Default
Type
Location
Description
summaryItem
String
pathReplace
A comma-separated list of
summary KPI to return, or
'availableMetrics' to see the
list of metrics available.
Content Type
application/json
Analytics
POST: Breakdown of Connected and Detected Devices for a Given Period and Areas
Description
granularity
Allowable values/formats
hourly
daily
weekly
monthly
yearly
tag
tag-name
heterarchy level
null
period
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
Analytics
POST: Breakdown of Connected and Detected Devices for a Given Period and Areas
Description
timeRange
aggregate
Allowable values/formats
HH:mm-HH:mm
now
none
sum
avg
areas
durationCategories
includeStationary
percentageOf
areaFilter
Heterarchy level
descendantOf
subsetOf:comma separated
ids
Analytics
POST: Breakdown of Connected and Detected Devices for a Given Period and Areas
Description
Allowable values/formats
expandAll
true
false
HTTP Method
POST
Resource URI
/api/analytics/v1/connectedDetected
Requires OAuth
N
Parameters
Table 13: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Content Type
application/json
Analytics
GET: Alerts for Device Count for a single Heterarchy Element and Time Frame
Name
Required
Default
Type
Location
Description
elementId
String
timeFrame
String
Content Type
application/json
Analytics
GET: Alerts for Device Count for a single Heterarchy Element
Name
Required
Default
Type
Location
elementId
String
Content Type
application/json
Description
Analytics
GET: Retrieves Alerts for Device Count
Analytics
POST: Queue Time for a Given Period and Areas
Description
period
Allowable values/formats
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
tag
heterarchy level
timeRange
HH:mm-HH:mm
now
The ID of the area
Analytics
POST: Queue Time for a Given Period and Areas
Description
granularity
Allowable values/formats
fifteen min
hourly
daily
weekly
monthly
yearly
areaFilter
descendantOf
subsetOf:comma separated
ids
true
false
HTTP Method
POST
Analytics
POST: Queue Time for a Given Period and Areas
Resource URI
/api/analytics/v1/queue
Requires OAuth
N
Parameters
Table 17: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Content Type
application/json
Analytics
POST: Overview Data for Target Areas for Brochure View
Description
type
Allowable values/formats
deviceCount
deviceDwell
grossShopping
deviceCrossover
connectedDetected
dwellBreakdown
period
yyyy-mm-dd
yyyy-mm-dd;yyyy-mm-dd
today
yesterday
this week
last week
last 2 weeks
this month
last month
last 3 months
this year
last year
forever
timeRange
HH:mm-HH:mm
now
areas
Analytics
POST: Overview Data for Target Areas for Brochure View
Description
Allowable values/formats
durationCategories
includeStationary
true
false
entirePeriod
connectionState
percentageOf
dwellLimits
HTTP Method
POST
Resource URI
/api/analytics/v1/overview
Requires OAuth
N
true
false
connected
detected
all
Heterarchy level
default
comma separated limit
label:limit value
Analytics
POST: Overview Data for Target Areas for Brochure View
Parameters
Table 19: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters
Content Type
application/json
Analytics
POST: Dwell Time for a Given Period and Areas
Description
granularity
Allowable values/formats
hourly
daily
weekly
monthly
yearly
tag
tag-name
heterarchy level
null
period
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
Analytics
POST: Dwell Time for a Given Period and Areas
Description
timeRange
Allowable values/formats
HH:mm-HH:mm
now
aggregate
none
sum
avg
areas
durationCategories
includeStationary
connectionState
connected
detected
all
percentageOf
Heterarchy level
Analytics
POST: Dwell Time for a Given Period and Areas
Description
Allowable values/formats
areaFilter
descendantOf
subsetOf:comma separated
ids
true
false
HTTP Method
POST
Resource URI
/api/analytics/v1/deviceDwell
Requires OAuth
N
Parameters
Table 21: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters.
Analytics
POST: Dwell Time for a Given Period and Areas
Content Type
application/json
Analytics
POST: Device Count for a Given Period and Areas
Description
granularity
Allowable values/formats
hourly
daily
weekly
monthly
yearly
tag
tag-name
heterarchy level
null
period
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
Analytics
POST: Device Count for a Given Period and Areas
Description
timeRange
aggregate
Allowable values/formats
HH:mm-HH:mm
now
none
sum
avg
areas
durationCategories
includeStationary
connectionState
connected
detected
all
percentageOf
Heterarchy level
Analytics
POST: Device Count for a Given Period and Areas
Description
Allowable values/formats
areaFilter
descendantOf
subsetOf:comma separated
ids
true
false
HTTP Method
POST
Resource URI
/api/analytics/v1/deviceCount
Requires OAuth
N
Parameters
Table 23: Parameter Details
Name
Required
Default
Type
Location
Description
body
JSON array
body
JSON array
containing
parameters
Analytics
POST: Device Count for a Given Period and Areas
Content Type
application/json
Analytics
POST: Device Count for a Given Period and Areas
Configuration
GET: Get Supported Northbound Notifications, page 46
GET: Current CMX Image Version, page 47
GET: Count of Active Alerts, page 48
GET: All Alerts, page 49
POST: Add Role to User, page 50
DELETE: Role from User, page 51
GET: All Users in the System, page 52
POST: Create a User, page 53
POST: Modify User, page 54
GET: User by Username, page 55
DELETE: User by Username, page 56
GET: All Roles, page 57
GET: All Campuses, page 58
GET: Campus by Name, page 59
PUT: Add Campus, page 60
GET: Count of All Map Elements, page 61
GET: List of all Building Names., page 62
GET: List of all Building Names, page 63
GET: List of all Floor Names, page 64
GET: List of all Floor Names, page 65
GET: All Maps, page 66
GET: Campus by Name, page 67
GET: Building by Name Inside Specific Campus, page 68
GET: Floor Inside Specific Building and Specific Campus, page 69
Configuration
Configuration
Configuration
GET: Get Supported Northbound Notifications
Configuration
GET: Current CMX Image Version
Configuration
GET: Count of Active Alerts
Configuration
GET: All Alerts
Configuration
POST: Add Role to User
Name
Required
Default
Type
Location
Description
username
String
pathReplace
rolename
String
pathReplace
Content Type
application/json
Configuration
DELETE: Role from User
Name
Required
Default
Type
Location
Description
username
String
pathReplace
Username of user.
rolename
String
pathReplace
Content Type
application/json
Configuration
GET: All Users in the System
Configuration
POST: Create a User
Name
Required
Default
Type
Location
Description
___username
string
body
password
string
body
firstname
string
body
lastname
string
body
roles
text
body
developerkey
string
body
lastlogin
text
body
Content Type
application/json
Configuration
POST: Modify User
Name
Required
Default
Type
Location
username
String
___username
string
body
password
string
body
firstname
string
body
lastname
string
body
roles
text
body
developerkey
string
body
lastlogin
text
body
Content Type
application/json
Description
Configuration
GET: User by Username
Name
Required
Default
Type
Location
Description
username
String
pathReplace
Username
Content Type
application/json
Configuration
DELETE: User by Username
Name
Required
Default
Type
Location
Description
username
String
pathReplace
Username.
Content Type
application/json
Configuration
GET: All Roles
Configuration
GET: All Campuses
Configuration
GET: Campus by Name
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Campus Name .
Content Type
application/json
Configuration
PUT: Add Campus
Name
Required
Default
Type
Location
Description
objectVersion
number
body
objectVersion
name
string
body
dimension
text
body
Dimension
image
text
body
image
buildingList
text
body
aesUid
number
body
aesUid
aesUidString
string
body
aesUidString
members
text
body
members
Content Type
application/json
Configuration
GET: Count of All Map Elements
Configuration
GET: List of all Building Names.
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Campus Name
Content Type
application/json
Configuration
GET: List of all Building Names
Configuration
GET: List of all Floor Names
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Building Name
Content Type
application/json
Configuration
GET: List of all Floor Names
Configuration
GET: All Maps
Configuration
GET: Campus by Name
Name
Required
Default
Type
Location
Description
campusName
String
pathReplace
Campus Name
Content Type
application/json
Configuration
GET: Building by Name Inside Specific Campus
Name
Required
Default
Type
Location
Description
campusName
String
pathReplace
Campus Name.
buildingName
String
pathReplace
Building Name.
Content Type
application/json
Configuration
GET: Floor Inside Specific Building and Specific Campus
Name
Required
Default
Type
Location
Description
campusName
String
pathReplace
Campus Name.
buildingName
String
pathReplace
Building Name.
floorName
String
pathReplace
Floor Name.
Content Type
application/json
Configuration
GET: Floor Image
Name
Required
Default
Type
Location
Description
campusName
String
pathReplace
Campus Name.
buildingName
String
pathReplace
Building Name.
floorName
String
pathReplace
Floor Name.
Content Type
application/json
Configuration
GET: Image by Name
Name
Required
Default
Type
Location
Description
imageName
String
pathReplace
Image Name.
Content Type
application/json
Configuration
GET: All Sites
Configuration
GET: Site Details by ID or Name
Configuration
GET: System Settings
Name
Required
Default
Type
Location
Description
component
String
pathReplace
The component.
key
String
pathReplace
Content Type
application/json
Configuration
PUT: System Settings
Name
Required
Default
Type
Location
Description
component
String
pathReplace
The component.
key
String
pathReplace
The key.
String
string
body
Value.
Content Type
application/json
Configuration
GET: All Notification Subscriptions
Configuration
GET: Notifications by Name
Name
Required
Default
Type
Location
Description
name
String
Content Type
application/json
Configuration
GET: Notification Subscription Availability
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Notification Name.
Content Type
application/json
Configuration
PUT: Add Notification Subscription
Name
Required
Default
Type
Location
Description
userId
string
body
User ID.
rules
text
body
List of rules.
subscribers
text
body
Subscribers
Configuration
PUT: Add Notification Subscription
Name
Required
Default
Type
Location
notificationType
enumerated body
Description
Choose one of the following
notification types:
Any
Absence
AreaChange
Association
BatteryLife
Chokepoint
Containment
Emergency
Movement
Presence
LocationUpdate
Zone
Location
ServiceStatus
NetworkDesignChanged
CpuUsage
MemoryUsage
DiskUsage
BeaconMovement
BeaconAbsence
Update
InOut
PasserbyDetected
PasserbyBecameVisitor
VisitorWentAway
SiteEntryChanged
enabled
enumerated body
enabled
true
false
Configuration
PUT: Add Notification Subscription
Name
Required
enableMacScrambling N
Default
Type
Location
enumerated body
Description
enableMacScrambling
true
false
Content Type
application/json
Configuration
PUT: List of Notification Subscriptions
Configuration
DELETE: Notification Subscription
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Notification
Name.
Content Type
application/json
Configuration
GET: System Alert Subscription
Configuration
GET: Notifications by Name
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Notification
Name.
Content Type
application/json
Configuration
PUT: System Alert Subscription
Name
Required
Default
Type
Location
Description
severity
enumerated
body
userId
string
body
User ID.
rules
text
body
List of rules.
subscribers
text
body
Subscribers
Configuration
PUT: System Alert Subscription
Name
Required
notificationType Y
Default
Type
Location
Description
enumerated
body
enabled
enumerated
body
enabled
true
false
Configuration
PUT: System Alert Subscription
Name
Required
enableMacScrambling N
Default
Type
Location
Description
enumerated
body
enableMacScrambling
true
false
Content Type
application/json
Configuration
PUT: List of System Alert Subscriptions
Configuration
DELETE: Notification Alert Subscription
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Notification
Name.
Content Type
application/json
Configuration
POST: Change Status of Notification by Name
Name
Required
Default
Type
Location
Description
name
String
pathReplace
Notification
Name.
action
String
pathReplace
Enable/Disable
Content Type
application/json
Configuration
GET: Unique Alerts by Time Interval
Name
Required
Default
Type
Location
Description
startTime
Number
query
endTime
Number
query
Content Type
application/json
Configuration
GET: Alert by Time Interval
Name
Required
Default
Type
Location
Description
startTime
Number
query
endTime
Number
query
Content Type
application/json
Configuration
GET: Alerts by Time Interval and Hashkey
Name
Required
Default
Type
Location
Description
key
String
pathReplace
startTime
Number
query
endTime
Number
query
Content Type
application/json
Configuration
GET: Total Alerts Created for a Given Alert Key
Name
Required
Default
Type
Location
Description
key
String
pathReplace
Content Type
application/json
Configuration
GET: All APs
Configuration
GET: Access Point by MAC Address
Name
Required
Default
Type
Location
Description
mac
String
pathReplace
Access point
MAC address.
Content Type
application/json
Configuration
GET: Settings for a Given User
Name
Required
Default
Type
Location
userid
String
component
String
key
String
Content Type
application/json
Description
Configuration
PUT: Setting for a Given User
Name
Required
Default
Type
Location
Description
userid
String
pathReplace
component
String
pathReplace
The component.
key
String
pathReplace
The key.
json
String
query
String
string
body
Value
Content Type
application/json
Configuration
GET: All Cisco WLC Controllers
Configuration
GET: Get Cisco WLC Controllers by IP address
Name
Required
Default
Type
Location
Description
ipAddress
String
pathReplace
IP Address.
Content Type
application/json
Configuration
PUT: Controller
PUT: Controller
Description
This API allows you to add a controller.
HTTP Method
PUT
Resource URI
/api/config/v1/controllers
Requires OAuth
N
Parameters
Table 57: Parameter Details
Name
Required
Default
Type
Location
Description
name
string
body
ipAddress
string
body
readOnlyComm
string
body
writeComm
string
body
snmpVersion
number
body
SNMP Version.
version
string
body
userName
string
body
authType
number
body
authPassword
string
body
Authentication Password.
privType
number
body
Privacy Type.
privPassword
string
body
Password.
Configuration
PUT: Controller
Name
Required
Default
Type
Location
Description
macAddress
string
body
MAC Address.
sysUpTime
number
body
System Up time.
unauthenticatedConnection N
enumerated body
applicableServices Y
array
body
aesUId
number
body
objectVersion
number
body
Object version.
tagNotificationInterval N
number
body
wlanConfigList
text
body
deviceVersion
string
body
type
enumerated body
type
WLC
NGWC
enablePassword
string
peerMode
enumerated body
body
enablePassword
peerMode
true
false
members
text
body
Members.
Content Type
application/json
Configuration
POST: Devices to the opt-out List
Configuration
DELETE: List of Devices from Opt-out
Configuration
DELETE: All opt-out Devices
Configuration
GET: List of Opt-out Devices Within a Date Range
Name
Required
Default
Type
Location
Description
validFrom
String
query
validTo
String
query
Content Type
application/json
Configuration
GET: Count of opt-out Devices
Configuration
DELETE: Opt-out Devices Within a Date Range
Name
Required
Default
Type
Location
Description
validFrom
String
query
validTo
String
query
Content Type
application/json
Configuration
GET: List of Children Superzone IDs of a Hiterarchy Element
Name
Required
Default
Type
Location
Description
pathSegments
String
pathReplace
validDate
String
query
Show elements
valid at given
date
(yyyy-mm-dd
HH:mm:ss)
Allowed
values/formats:
yyyy-mm-dd
HH:mm:ss.
level
String
query
Level name
(SUPERZONE,
FLOOR, AP,
POI, or ZONE)
Allowed
values/formats:
SUPERZONE
FLOOR AP
ZONE POI.
Configuration
GET: List of Children Superzone IDs of a Hiterarchy Element
Content Type
application/json
Configuration
GET: Children Superzone IDs of Hiterarchy Element
Name
Required Default
Type
Location
Description
pathSegments
String
pathReplace
validDate
String
query
level
String
query
Content Type
application/json
Connect
GET: Query User Sessions, page 114
Connect
GET: Query User Sessions
Name
Required
Default
Type
Location
Description
start
String
query
end
String
query
index
String
query
count
String
query
status
String
query
authtype
String
query
Connect
GET: Query User Sessions
Name
Required
Default
Type
Location
Description
mac
String
query
MAC address in
00:11:22:33:44:55:66 format. If
MAC address is used, all other
parameters will be ignored.
device
String
query
os
String
query
language
String
query
all
String
query
Content Type
application/json
Connect
GET: Query User Sessions
Location
GET: Active Tags Count, page 118
GET: All Tags, page 119
GET: Tag by MAC Address, page 120
GET: Supported Northbound Notifications, page 121
GET: Count of all the Beacons, page 122
PUT: Place a Beacon at Detected Location on Map, page 123
PUT: Updates Name of a Given Beacon, page 124
GET: List of Beacons Matching Filter Criteria, page 125
POST: Add Beacon with Minimum Fields, page 126
GET: Beacons with Minimum Information for a Floor ID, page 127
GET: List of Beacons, page 128
GET: Beacon by MAC Address, page 129
DELETE: Delete Beacon by MAC Address, page 130
PUT: Update Beacon, page 131
GET: List of Beacons Present on a Floor, page 133
POST: Add Beacon to the Store, page 134
GET: Active Clients Count, page 136
GET: All clients, page 137
GET: Collection of Active Clients MAC Address, page 138
GET: Compact History of Client by Date and Username, page 139
GET: Unique MAC Address Seen on a Given Day on a Floor or Zone, page 140
GET: Compact History of Client By Date and IPv4 Address, page 142
GET: This API returns history for all clients, page 143
GET: History of Client by MAC Address, page 144
Location
GET: Active Tags Count
Location
GET: All Tags
Location
GET: Tag by MAC Address
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
Tag MAC
address.
Content Type
application/json
Location
GET: Supported Northbound Notifications
Location
GET: Count of all the Beacons
Location
PUT: Place a Beacon at Detected Location on Map
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
Mac address of
beacon.
Content Type
application/json
Location
PUT: Updates Name of a Given Beacon
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
name
String
pathReplace
Content Type
application/json
Location
GET: List of Beacons Matching Filter Criteria
Name
Required
Default
Type
Location
Description
floorrefid
Number
filterString
String
Content Type
application/json
Location
POST: Add Beacon with Minimum Fields
Name
Required
Default
Type
Location
Description
queryString
String
pathReplace
Value of the
queryString.
Content Type
application/json
Location
GET: Beacons with Minimum Information for a Floor ID
Name
Required
Default
Type
Location
Description
floorrefid
Number
pathReplace
Reference ID of
the floor.
Content Type
application/json
Location
GET: List of Beacons
Location
GET: Beacon by MAC Address
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
Mac address of
beacon.
Content Type
application/json
Location
DELETE: Delete Beacon by MAC Address
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
Mac address of
beacon to be
deleted.
Content Type
application/json
Location
PUT: Update Beacon
Name
Required
Default
Type
Location
Description
macAddress
string
body
MAC Address.
name
string
body
Name
type
enumerated
body
Known
Rogue
Unplaced
detectedOn
number
body
status
enumerated
body
detectedOn
Active
Missing
Misplaced
Inactive
NeverDetected
number
body
expectedHierarchyString N
string
body
Expected Hierarchy
String.
lastUpdatedOn
Location
PUT: Update Beacon
Name
Required
Default
Type
Location
Description
actualHierarchyString N
string
body
Actual Hierarchy
String.
uuid
string
body
UUID
major
string
body
Major.
minor
string
body
Minor
manufacturerId
string
body
Manufacturer ID
rssi
string
body
RSSI value.
mapInfo
text
body
Map Information.
mapCoordinate
text
body
Map coordinate.
detectedLocation N
text
body
Detected Location.
configuredLocation N
text
body
Configured Location.
Content Type
application/json
Location
GET: List of Beacons Present on a Floor
Name
Required
Default
Type
Location
Description
floorrefid
Number
pathReplace
Reference ID of
the floor.
Content Type
application/json
Location
POST: Add Beacon to the Store
Name
Required
Default
Type
Location
Description
macAddress
string
body
MAC Address.
name
string
body
type
enumerated
body
Known
Rogue
Unplaced
detectedOn
number
body
status
enumerated
body
Detected On.
Active
Missing
Misplaced
Inactive
NeverDetected
number
body
expectedHierarchyString N
string
body
lastUpdatedOn
Location
POST: Add Beacon to the Store
Name
Required
Default
Type
Location
Description
actualHierarchyString N
string
body
uuid
string
body
UUID
major
string
body
Major
minor
string
body
Minor
manufacturerId
string
body
Manufacturer ID
rssi
string
body
RSSI value.
mapInfo
text
body
Map Info.
mapCoordinate
text
body
Map coordinate.
detectedLocation
text
body
Detected Location.
configuredLocation N
text
body
Configured Location.
Content Type
application/json
Location
GET: Active Clients Count
Location
GET: All clients
Location
GET: Collection of Active Clients MAC Address
Location
GET: Compact History of Client by Date and Username
Name
Required
Default
Type
Location
Description
date
String
query
Date in format of
yyyy/mm/dd
username
String
pathReplace
User name.
Content Type
application/json
Location
GET: Unique MAC Address Seen on a Given Day on a Floor or Zone
Name
Required
Default
Type
Location
Description
hierarchy
String
query
Hierarchy in format
campus-name/building-name/floor-name.
Location
GET: Unique MAC Address Seen on a Given Day on a Floor or Zone
Name
Required
Default
Type
Location
Description
date
String
query
floorid
String
query
Floor ID.
zoneid
String
query
Zone ID.
fromHour
String
query
FromHour, HH in 24 hour
format.
toHour
String
query
String
query
String
query
distance
String
query
Distance in feet
Content Type
application/json
Location
GET: Compact History of Client By Date and IPv4 Address
Name
Required
Default
Type
Location
Description
date
String
query
Date in format
of yyyy/mm/dd.
ipv4address
String
pathReplace
IPv4 Address.
Content Type
application/json
Location
GET: This API returns history for all clients
Location
GET: History of Client by MAC Address
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
Client
Macaddress.
date
String
query
Date in format
of yyyy/mm/dd.
Content Type
application/json
Presence
GET: Count of Passersby Today, page 149
GET: Count of Passersby Yesterday, page 150
GET: Average Count of Passersby in Last 3 Days, page 151
GET: Average Count of Passersby in the Last 7 days, page 152
GET: Average Count of Passersby in the Last 30 Days, page 153
GET: Sum of Passerby Counts in the Specified Date Range, page 154
GET: Sum of Passerby Counts in the Last 3 Days, page 155
GET: Sum of Passerby Counts in the Last 7 Days, page 156
GET: Count of Passersby on a Given Date, page 157
GET: Sum of Passerby Counts in the Last 30 days, page 158
GET: Hourly Count of Passersby Today, page 159
GET: Hourly Count of Passersby Yesterday, page 160
GET: Hourly Count of Passersby for Last 3 days, page 161
GET: Hourly Count of Passersby for a Day, page 162
GET: Daily Count of Passersby for a Specified Date Range, page 163
GET: Daily Count of Passersby for the Last 7 days, page 164
GET: Daily count of passersby for the last 30 days, page 165
GET: Daily Count of Passersby by hour for the Specified Date Range, page 166
GET: Excluded Client Counts, page 167
GET: Active Clients, page 168
GET: Client Detail, page 169
GET: Count of Connected Visitors for a Date, page 170
GET: Count of Connected Visitors Seen today Until Now, page 171
GET: Count of Connected Visitors Seen Yesterday, page 172
Presence
GET: Average Count of Connected Visitors Seen in Last 3 Days, page 173
GET: Average Count of Connected Visitors Seen in Last 7 Days, page 174
GET: Average Count of Connected Visitors seen in last 30 Days, page 175
GET: Sum of Connected Visitor Counts in Last 3 days, page 176
GET: Sum of Connected Visitor Counts in Last 7 days, page 177
GET: Sum of Connected Visitor Counts in Last 30 days, page 178
GET: Sum of Connected Visitor Counts in the Specified Date Range, page 179
GET: Hourly Count of Connected Visitors Today, page 180
GET: Hourly Count of Connected Visitors Yesterday, page 181
GET: Hourly Count of Connected Visitors in Last 3 Days, page 182
GET: Hourly Count of Connected Visitors for the Specified Day, page 183
GET: Daily Count of Connected Visitors for the Specified Date Range, page 184
GET: Daily Count of Connected Visitors for Last 7 days, page 185
GET: Daily Count of Connected Visitors for last 30 Days, page 186
GET: Daily Count of Connected Visitors by Hour for the Specified Date Range, page 187
GET: Site KPI Summary for Specified Date or Date Range, page 188
GET: Site KPI Summary for Today, page 189
GET: Site KPI Summary for Yesterday, page 190
GET: Site KPI Summary for Last 3 Days, page 191
GET: Site KPI Summary for last 7 days, page 192
GET: Site KPI Summary for Last 30 Days, page 193
GET: Site Insights for Specified Date or Date Range, page 194
GET: Average Count of Repeat Visitors for Last 7 Days, page 195
GET: Average Count of Repeat Visitors for Last 30 days, page 196
GET: Sum of Repeat Visitor Counts for Last 3 days, page 197
GET: Sum of Repeat Visitor Counts for Last 7 days, page 198
GET: Sum of Repeat Visitor Counts for Last 30 days, page 199
GET: Hourly Count of Repeat Visitors for a Day, page 200
GET: Hourly Count of Repeat Visitors Today, page 201
GET: Hourly Count of Repeat Visitors Yesterday, page 202
GET: Count of Repeat Visitors for a Date or Date Range, page 203
GET: Count of Repeat Visitors for Today, page 204
GET: Count of Repeat Visitors for Yesterday, page 205
Presence
GET: Average Count of Repeat Visitors for Last 3 days, page 206
GET: Average Count of Repeat Visitors for Specified Date Range, page 207
GET: Hourly Count of Repeat Visitors for Last 3 Days, page 208
GET: Repeat Visitor Summary for a Day, page 209
GET: Repeat Visitor Summary for a Week, page 210
GET: Repeat Visitor Summary for a Month, page 211
GET: Daily Count of Repeat Visitors for Specified Date Range, page 212
GET: Daily Count of Repeat Visitors for Last 7 Days, page 213
GET: Daily Count of Repeat Visitors for Last 30 days, page 214
GET: Peak Hour of Visitors Today, page 215
GET: Count of Visitors Today, page 216
GET: Count of Visitors Yesterday, page 217
GET: Count of Unique Visitors for Last 3 Days, page 218
GET: Count of Unique Visitors for Last Week, page 219
GET: Count of Unique Visitors for Last Month, page 220
GET: Count of Unique Visitors for a Date/Date Range, page 221
GET: Sum of Visitor Counts for a Date Range, page 222
GET: Sum of Visitor Counts for the Last 3 Days, page 223
GET: Sum of Visitor Counts for the Last Week, page 224
GET: Sum of Visitor Counts for the Last Month, page 225
GET: Hourly Count of Visitors Today, page 226
GET: Hourly Count of Visitors Yesterday, page 227
GET: Hourly Count of Visitors for Last 3 Days, page 228
GET: Hourly Count of Visitors for a Day, page 229
GET: Daily Count of Visitors for a Date Range, page 230
GET: Daily Count of Visitors for Last Week, page 231
GET: Daily Count of Visitors for Last Month, page 232
GET: Daily Count of Visitors by Hour Category for a Date Range, page 233
GET: Visitor Summary for a Day, page 234
GET: Visitor Summary for Week, page 235
GET: Visitor Summary for Month, page 236
GET: Count of Visitors by Dwell Level for a Date or Date Range, page 237
GET: Count of Visitors by Dwell Level for Today, page 238
Presence
Presence
GET: Count of Passersby Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Passersby Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Count of Passersby in Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Count of Passersby in the Last 7 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Count of Passersby in the Last 30 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Sum of Passerby Counts in the Specified Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Sum of Passerby Counts in the Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Sum of Passerby Counts in the Last 7 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Passersby on a Given Date
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Presence
GET: Sum of Passerby Counts in the Last 30 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Passersby Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Passersby Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Passersby for Last 3 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Passersby for a Day
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Presence
GET: Daily Count of Passersby for a Specified Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Daily Count of Passersby for the Last 7 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Daily count of passersby for the last 30 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Daily Count of Passersby by hour for the Specified Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Excluded Client Counts
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Active Clients
Presence
GET: Client Detail
Name
Required
Default
Type
Location
Description
macaddress
String
pathReplace
MAC address
Content Type
application/json
Presence
GET: Count of Connected Visitors for a Date
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Presence
GET: Count of Connected Visitors Seen today Until Now
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Connected Visitors Seen Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Count of Connected Visitors Seen in Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Count of Connected Visitors Seen in Last 7 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Count of Connected Visitors seen in last 30 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Sum of Connected Visitor Counts in Last 3 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Sum of Connected Visitor Counts in Last 7 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Sum of Connected Visitor Counts in Last 30 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Sum of Connected Visitor Counts in the Specified Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Hourly Count of Connected Visitors Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Connected Visitors Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Connected Visitors in Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
Content Type
application/json
Presence
GET: Hourly Count of Connected Visitors for the Specified Day
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
date
String
query
Date
Content Type
application/json
Presence
GET: Daily Count of Connected Visitors for the Specified Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Daily Count of Connected Visitors for Last 7 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Daily Count of Connected Visitors for last 30 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Daily Count of Connected Visitors by Hour for the Specified Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Site KPI Summary for Specified Date or Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Site KPI Summary for Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Site KPI Summary for Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Site KPI Summary for Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Site KPI Summary for last 7 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Site KPI Summary for Last 30 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Site Insights for Specified Date or Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Average Count of Repeat Visitors for Last 7 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Count of Repeat Visitors for Last 30 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Sum of Repeat Visitor Counts for Last 3 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Sum of Repeat Visitor Counts for Last 7 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Sum of Repeat Visitor Counts for Last 30 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Repeat Visitors for a Day
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Presence
GET: Hourly Count of Repeat Visitors Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Repeat Visitors Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Repeat Visitors for a Date or Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Count of Repeat Visitors for Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Repeat Visitors for Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Count of Repeat Visitors for Last 3 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Count of Repeat Visitors for Specified Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Hourly Count of Repeat Visitors for Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Repeat Visitor Summary for a Day
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Presence
GET: Repeat Visitor Summary for a Week
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Presence
GET: Repeat Visitor Summary for a Month
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Presence
GET: Daily Count of Repeat Visitors for Specified Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Daily Count of Repeat Visitors for Last 7 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Daily Count of Repeat Visitors for Last 30 days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Peak Hour of Visitors Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Visitors Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Visitors Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Unique Visitors for Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Unique Visitors for Last Week
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Unique Visitors for Last Month
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Unique Visitors for a Date/Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
date
String
query
Date
Content Type
application/json
Presence
GET: Sum of Visitor Counts for a Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start date
endDate
String
query
End date
Content Type
application/json
Presence
GET: Sum of Visitor Counts for the Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Sum of Visitor Counts for the Last Week
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Sum of Visitor Counts for the Last Month
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Visitors Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Visitors Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
Content Type
application/json
Presence
GET: Hourly Count of Visitors for Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
Content Type
application/json
Presence
GET: Hourly Count of Visitors for a Day
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
date
String
query
Date
Content Type
application/json
Presence
GET: Daily Count of Visitors for a Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Daily Count of Visitors for Last Week
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Daily Count of Visitors for Last Month
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Daily Count of Visitors by Hour Category for a Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Visitor Summary for a Day
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Presence
GET: Visitor Summary for Week
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Presence
GET: Visitor Summary for Month
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Presence
GET: Count of Visitors by Dwell Level for a Date or Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Count of Visitors by Dwell Level for Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Visitors by Dwell Level for Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Visitors by Dwell Level for Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Visitors by Dwell Level for Last 7 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Count of Visitors by Dwell Level for Last 30 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Count of Visitors by Dwell Level for Last 7 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Count of Visitors by Dwell Level for Last 30 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Visitors by Dwell Level for a Specific Day
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
Content Type
application/json
Presence
GET: Hourly Count of Visitors by Dwell Level for Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Visitor Dwell Time by Dwell Level for Last 7 Days
GET: Average Visitor Dwell Time by Dwell Level for Last 7 Days
Description
This API returns the average visitor dwell time in minutes categorized by dwell level for last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagebylevel/lastweek
Requires OAuth
N
Parameters
Table 175: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Visitor Dwell Time by Dwell Level for Last 30 Days
GET: Average Visitor Dwell Time by Dwell Level for Last 30 Days
Description
This API returns the average visitor dwell time in minutes categorized by dwell level for last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagebylevel/lastmonth
Requires OAuth
N
Parameters
Table 176: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Daily Average Visitor Dwell Time by Dwell Level for a Specific Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Daily Average Visitor Dwell Time by Dwell Level for Last 7 Days
GET: Daily Average Visitor Dwell Time by Dwell Level for Last
7 Days
Description
This API returns the daily average visitor dwell time in minutes categorized by dwell level for the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/dailyaverage/lastweek
Requires OAuth
N
Parameters
Table 178: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Daily Average Visitor Dwell Time by Dwell Level for Last 30 Days
GET: Daily Average Visitor Dwell Time by Dwell Level for Last
30 Days
Description
This API returns the daily average visitor dwell time in minutes categorized by dwell level for the last 30
days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/dailyaverage/lastmonth
Requires OAuth
N
Parameters
Table 179: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Hourly Count of Visitors by Dwell level for Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site Id
Content Type
application/json
Presence
GET: Hourly Count of Visitors by Dwell Level for Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Daily Count of Visitors by Dwell Level for a Specific Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Daily Count of Visitors by Dwell Level for Last 7 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Daily Count of Visitors by Dwell Level for Last 30 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Visitor Dwell Time for the Specific Date or Date Range
GET: Average Visitor Dwell Time for the Specific Date or Date
Range
Description
This API returns the average visitor dwell time in minutes for the specified date or date range.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/average
Requires OAuth
N
Parameters
Table 185: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
startDate
String
query
Start Date
endDate
String
query
End Date
date
String
query
Date
Content Type
application/json
Presence
GET: Average Visitor Dwell Time for Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Visitor Dwell Time for Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Visitor Dwell Time for Last 3 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Visitor Dwell Time for Last 7 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Visitor Dwell Time for Last 30 Days
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Visitor Dwell Time by Dwell Level for a Specific Date or Date Range
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
date
String
query
Date
startDate
String
query
Start Date
endDate
String
query
End Date
Content Type
application/json
Presence
GET: Average Visitor Dwell Time by Dwell Level for Today
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Visitor Dwell Time by Dwell Level for Yesterday
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json
Presence
GET: Average Visitor Dwell Time by Dwell Level for Last 3 days
GET: Average Visitor Dwell Time by Dwell Level for Last 3 days
Description
This API returns the average visitor dwell time in minutes categorized by dwell level for last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/dwell/averagebylevel/3days
Requires OAuth
N
Parameters
Table 194: Parameter Details
Name
Required
Default
Type
Location
Description
siteId
Number
query
Site ID
Content Type
application/json