Connected Visitors API
GET: Count of Connected Visitors for a Date
Description
This API returns the count of connected visitors seen on a given day.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count?siteId=<Site ID>&date=<date in yyyy-mm-dd>
Requires Basic Auth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
date |
Y |
— |
String |
query |
Date in yyyy-mm-dd format |
Content Type
application/json
Sample Output
3
GET: Count of Connected Visitors Seen today Until Now
Description
This API returns the count of connected visitors seen today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count/today
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count/today?siteId=<Site ID>
Sample Output
Number
GET: Count of Connected Visitors Seen Yesterday
Description
This API returns the count of connected visitors seen yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count/yesterday
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count/yesterday?siteId=<Site ID>
Sample Output
Number
GET: Average Count of Connected Visitors Seen in Last 3 Days
Description
This API returns the average count of connected visitors seen in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count/3days
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count/3days?siteId=<Site ID>
Sample Output
Number
GET: Average Count of Connected Visitors Seen in Last 7 Days
Description
This API returns the average count of connected visitors seen in the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count/lastweek
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count/lastweek?siteId=<Site ID>
Sample Output
Number
GET: Average Count of Connected Visitors seen in last 30 Days
Description
This API returns the average count of connected visitors seen in the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/count/lastmonth
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count/lastmonth?siteId=<Site ID>
Sample Output
Number
GET: Sum of Connected Visitor Counts in Last 3 days
Description
This API returns the the sum of connected visitor counts for each day in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/total/3days
Requires Basic Auth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/total/3days?siteId=<Site ID>
Sample Output
Number
GET: Sum of Connected Visitor Counts in Last 7 days
Description
This API returns the the sum of connected visitor counts for each day in the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/total/lastweek
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/total/lastweek?siteId=<Site ID>
Sample Output
Number
GET: Sum of Connected Visitor Counts in Last 30 days
Description
This API returns the the sum of connected visitor counts for each day in the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/total/lastmonth
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/total/lastmonth?siteId=<Site ID>
Sample Output
Number
GET: Sum of Connected Visitor Counts in the Specified Date Range
Description
This API returns the sum of connected visitor counts for each day in the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/total
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
startDate |
Y |
— |
String |
query |
Start Date |
endDate |
Y |
— |
String |
query |
End Date |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/total/?siteId=<Site ID>&startDate=<date in yyyy-mm-dd>&endDate=<date in yyyy-mm-dd>
Sample Output
Number
GET: Hourly Count of Connected Visitors Today
Description
This API returns the hourly count of connected visitors today until now.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/hourly/today
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
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
}
GET: Hourly Count of Connected Visitors Yesterday
Description
This API returns the hourly count of connected visitors yesterday.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/hourly/yesterday
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
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
}
GET: Hourly Count of Connected Visitors in Last 3 Days
Description
This API returns the hourly count of connected visitors in the last 3 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/hourly/3days
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site Id |
Content Type
application/json
GET: Hourly Count of Connected Visitors for the Specified Day
Description
This API returns the hourly count of connected visitors for the specified date.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/hourly
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site Id |
date |
N |
— |
String |
query |
Date |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/hourly/?siteId=<Site ID>&date=<date in yyyy-mm-dd>
Sample Output
{
"0":0,
"1":0,
"2":0,
"3":0,
"4":0,
"5":0,
"6":0,
"7":0,
"8":0,
"9":0
}
GET: Daily Count of Connected Visitors for the Specified Date Range
Description
This API returns the daily count of connected visitors for the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/daily
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
startDate |
Y |
— |
String |
query |
Start Date |
endDate |
Y |
— |
String |
query |
End Date |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/daily/?siteId=<Site ID>&startDate=<date in yyyy-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,
"2017-03-10":0
}
GET: Daily Count of Connected Visitors for Last 7 days
Description
This API returns the daily count of connected visitors for the last 7 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/daily/lastweek
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
Content Type
application/json
GET: Daily Count of Connected Visitors for last 30 Days
Description
This API returns the daily count of connected visitors for the last 30 days.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/daily/lastmonth
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
Content Type
application/json
GET: Daily Count of Connected Visitors by Hour for the Specified Date Range
Description
This API returns the daily count of connected visitors by hour category for the specified date range.
HTTP Method
GET
Resource URI
/api/presence/v1/connected/daily/hourcategory
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
siteId |
Y |
— |
Number |
query |
Site ID |
startDate |
Y |
— |
String |
query |
Start Date |
endDate |
Y |
— |
String |
query |
End Date |
Content Type
application/json
Usage Guidelines
https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/daily/hourcategory/?siteId=<Site ID>&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
},
"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
}
}