Presence

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

Parameters

Table 1. Parameter Details
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

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

Parameters

Table 2. Parameter Details
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

Parameters

Table 3. Parameter Details
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

Parameters

Table 4. Parameter Details
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

Parameters

Table 5. Parameter Details
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

Parameters

Table 6. Parameter Details
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

Parameters

Table 7. Parameter Details
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

Parameters

Table 8. Parameter Details
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

Parameters

Table 9. Parameter Details
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

Parameters

Table 10. Parameter Details
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

Parameters

Table 11. Parameter Details
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

Parameters

Table 12. Parameter Details
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

Parameters

Table 13. Parameter Details
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

Parameters

Table 14. Parameter Details
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

Parameters

Table 15. Parameter Details
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

Parameters

Table 16. Parameter Details
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

Parameters

Table 17. Parameter Details
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

Parameters

Table 18. Parameter Details
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
   }
}

Repeat Visitors API

GET: Average Count of Repeat Visitors for Last 7 Days

Description

This API returns the average count of repeat visitors seen in last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/average/lastweek

Requires OAuth

Parameters

Table 19. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Average Count of Repeat Visitors for Last 30 days

Description

This API returns the average count of repeat visitors seen in last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/average/lastmonth

Requires OAuth

Parameters

Table 20. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Sum of Repeat Visitor Counts for Last 3 days

Description

This API returns the sum of repeat visitor counts for each day in last 3 days.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/count/3days

Requires OAuth

Parameters

Table 21. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Sum of Repeat Visitor Counts for Last 7 days

Description

This API returns the sum of repeat visitor counts for each day in last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/count/lastweek

Requires OAuth

Parameters

Table 22. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Sum of Repeat Visitor Counts for Last 30 days

Description

This API returns the sum of repeat visitor counts for each day in last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/count/lastmonth

Requires OAuth

Parameters

Table 23. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Hourly Count of Repeat Visitors for a Day

Description

This API returns the hourly count of repeat visitors for the specified date.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/hourly

Requires OAuth

Parameters

Table 24. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date

Content Type

application/json

GET: Hourly Count of Repeat Visitors Today

Description

This API returns the hourly count of repeat visitors seen today until now.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/hourly/today

Requires OAuth

Parameters

Table 25. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Hourly Count of Repeat Visitors Yesterday

Description

This API returns the hourly count of repeat visitors seen yesterday.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/hourly/yesterday

Requires OAuth

Parameters

Table 26. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Repeat Visitors for a Date or Date Range

Description

This API returns the count of repeat visitors seen on a given day or date range.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/count

Requires OAuth

Parameters

Table 27. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date
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/repeatvisitors/count/?siteId=<Site ID>&startDate=<date in yyyy-mm-dd>&endDate=<date in yyyy-mm-dd>

Sample Output

{  
   "DAILY":0,
   "WEEKLY":0,
   "OCCASIONAL":0,
   "FIRST_TIME":0,
   "YESTERDAY":0
}

GET: Count of Repeat Visitors for Today

Description

This API returns the count of repeat visitors seen today until now.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/count/today

Requires OAuth

Parameters

Table 28. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Repeat Visitors for Yesterday

Description

This API returns the count of repeat visitors seen yesterday.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/count/yesterday

Requires OAuth

Parameters

Table 29. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Average Count of Repeat Visitors for Last 3 days

Description

This API returns the average count of repeat visitors seen in last 3 days.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/average/3days

Requires OAuth

Parameters

Table 30. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Average Count of Repeat Visitors for Specified Date Range

Description

This API returns the average count of repeat visitors seen for the specified date range.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/average

Requires OAuth

Parameters

Table 31. Parameter Details
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/repeatvisitors/average/?siteId=<Site ID>&startDate=<date in yyyy-mm-dd>&endDate=<date in yyyy-mm-dd>

Sample Output

{  
   "DAILY":0,
   "WEEKLY":0,
   "OCCASIONAL":0,
   "FIRST_TIME":0,
   "YESTERDAY":0
}

GET: Hourly Count of Repeat Visitors for Last 3 Days

Description

This API returns the hourly count of repeat visitors for the last 3 days.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/hourly/3days

Requires OAuth

Parameters

Table 32. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Repeat Visitor Summary for a Day

Description

This API returns the repeat visitor summary for the specified date.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/daysummary

Requires OAuth

Parameters

Table 33. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date

Content Type

application/json

GET: Repeat Visitor Summary for a Week

Description

This API returns the repeat visitor summary for the week of specified date.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/weeksummary

Requires OAuth

Parameters

Table 34. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date

Content Type

application/json

GET: Repeat Visitor Summary for a Month

Description

This API returns the repeat visitor summary for the month of specified date.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/monthsummary

Requires OAuth

Parameters

Table 35. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date

Content Type

application/json

GET: Daily Count of Repeat Visitors for Specified Date Range

Description

This API returns the daily count of repeat visitors for the specified date range.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/daily

Requires OAuth

Parameters

Table 36. Parameter Details
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/repeatvisitors/daily/?siteId=<Site ID>&startDate=<date in 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,
      "FIRST_TIME":0,
      "YESTERDAY":0
   }
}

GET: Daily Count of Repeat Visitors for Last 7 Days

Description

This API returns the daily count of repeat visitors for the last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/daily/lastweek

Requires OAuth

Parameters

Table 37. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Daily Count of Repeat Visitors for Last 30 days

Description

This API returns the daily count of repeat visitors for the last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/repeatvisitors/daily/lastmonth

Requires OAuth

Parameters

Table 38. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

Dwell API

GET: Count of Visitors by Dwell Level for a Date or Date Range

Description

This API returns the count of visitors categorized by dwell level seen on a given day or date range.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/count

Requires OAuth

Parameters

Table 39. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date
startDate	Y	—	String	query	Start Date
endDate	N	—	String	query	End Date

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/dwell/count/?siteId=<Site ID>&date=<date in yyyy-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
}

GET: Count of Visitors by Dwell Level for Today

Description

This API returns the count of visitors categorized by dwell level seen today until now.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/count/today

Requires OAuth

Parameters

Table 40. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Visitors by Dwell Level for Yesterday

Description

This API returns the count of visitors categorized by dwell level seen yesterday.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/count/yesterday

Requires OAuth

Parameters

Table 41. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Visitors by Dwell Level for Last 3 Days

Description

This API returns the count of visitors categorized by dwell level seen in the last 3 days.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/count/3days

Requires OAuth

Parameters

Table 42. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Visitors by Dwell Level for Last 7 Days

Description

This API returns the count of visitors categorized by dwell level seen in the last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/count/lastweek

Requires OAuth

Parameters

Table 43. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Visitors by Dwell Level for Last 30 Days

Description

This API returns the count of visitors categorized by dwell level seen in the last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/count/lastmonth

Requires OAuth

Parameters

Table 44. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Average Count of Visitors by Dwell Level for Last 7 Days

Description

This API returns the average count of visitors categorized by dwell level seen in the last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/averagecount/lastweek

Requires OAuth

Parameters

Table 45. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Average Count of Visitors by Dwell Level for Last 30 Days

Description

This API returns the average count of visitors categorized by dwell level seen in the last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/averagecount/lastmonth

Requires OAuth

Parameters

Table 46. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Hourly Count of Visitors by Dwell Level for a Specific Day

Description

This API returns the hourly count of visitors categorized by dwell level seen in the specified date.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/hourly

Requires OAuth

Parameters

Table 47. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date

Content Type

application/json

GET: Hourly Count of Visitors by Dwell Level for Today

Description

This API returns the hourly count of visitors categorized by dwell level seen today until now.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/hourly/today

Requires OAuth

Parameters

Table 48. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

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

Parameters

Table 49. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

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

Parameters

Table 50. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Daily Average Visitor Dwell Time by Dwell Level for a Specific Date Range

Description

This API returns the daily average visitor dwell time in minutes categorized by dwell level for the specified date range.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/dailyaverage

Requires OAuth

Parameters

Table 51. Parameter Details
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/dwell/dailyaverage/?siteId=<Site ID>&date=<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":{  
      "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
   }
}

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

Parameters

Table 52. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

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

Parameters

Table 53. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Hourly Count of Visitors by Dwell level for Yesterday

Description

This API returns the hourly count of visitors categorized by dwell level seen yesterday.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/hourly/yesterday

Requires OAuth

Parameters

Table 54. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site Id

Content Type

application/json

GET: Hourly Count of Visitors by Dwell Level for Last 3 Days

Description

This API returns the hourly count of visitors categorized by dwell level seen in the last 3 days.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/hourly/3days

Requires OAuth

Parameters

Table 55. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Daily Count of Visitors by Dwell Level for a Specific Date Range

Description

This API returns the daily count of visitors categorized by dwell level seen during the specified date range

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/daily

Requires OAuth

Parameters

Table 56. Parameter Details
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/dwell/daily/?siteId=<Site ID>&date=<date in yyyy-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,
      "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
   }
}

GET: Daily Count of Visitors by Dwell Level for Last 7 Days

Description

This API returns the daily count of visitors categorized by dwell level seen during the last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/daily/lastweek

Requires OAuth

Parameters

Table 57. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Daily Count of Visitors by Dwell Level for Last 30 Days

Description

This API returns the daily count of visitors categorized by dwell level seen during the last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/daily/lastmonth

Requires OAuth

Parameters

Table 58. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

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

Parameters

Table 59. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
startDate	Y	—	String	query	Start Date
endDate	Y	—	String	query	End Date
date	N	—	String	query	Date

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/dwell/average/?siteId=<Site ID>&date=<date in yyyy-mm-dd>

Sample Output

0.0

GET: Average Visitor Dwell Time for Today

Description

This API returns the average visitor dwell time in minutes for today until now.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/average/today

Requires OAuth

Parameters

Table 60. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Average Visitor Dwell Time for Yesterday

Description

This API returns the average visitor dwell time in minutes for yesterday.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/average/yesterday

Requires OAuth

Parameters

Table 61. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Average Visitor Dwell Time for Last 3 Days

Description

This API returns the average visitor dwell time in minutes for last 3 days.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/average/3days

Requires OAuth

Parameters

Table 62. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Average Visitor Dwell Time for Last 7 Days

Description

This API returns the average visitor dwell time in minutes for the last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/average/lastweek

Requires OAuth

Parameters

Table 63. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Average Visitor Dwell Time for Last 30 Days

Description

This API returns the average visitor dwell time in minutes for the last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/average/lastmonth

Requires OAuth

Parameters

Table 64. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Average Visitor Dwell Time by Dwell Level for a Specific Date or Date Range

Description

This API returns the average visitor dwell time in minutes categorized by dwell level for the specified date or date range.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/averagebylevel

Requires OAuth

Parameters

Table 65. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date
startDate	Y	—	String	query	Start Date
endDate	N	—	String	query	End Date

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/dwell/averagebylevel/?siteId=<Site ID>&date=<date in yyyy-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,
   "EIGHT_PLUS_HOURS":0.0
}

GET: Average Visitor Dwell Time by Dwell Level for Today

Description

This API returns the average visitor dwell time in minutes categorized by dwell level for today until now.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/averagebylevel/today

Requires OAuth

Parameters

Table 66. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Average Visitor Dwell Time by Dwell Level for Yesterday

Description

This API returns the average visitor dwell time in minutes categorized by dwell level for yesterday.

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/averagebylevel/yesterday

Requires OAuth

Parameters

Table 67. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

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

Parameters

Table 68. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

Visitors API

GET: Peak Hour of Visitors Today

Description

This API returns the hour that had peak visitors today.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/today/peakhour

Requires OAuth

Parameters

Table 69. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Visitors Today

Description

This API returns the count of visitors seen today until now.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/count/today

Requires OAuth

Parameters

Table 70. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Visitors Yesterday

Description

This API returns the count of visitors seen yesterday.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/count/yesterday

Requires OAuth

Parameters

Table 71. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Unique Visitors for Last 3 Days

Description

This API returns the count of unique visitors seen in the last 3 days.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/count/3days

Requires OAuth

Parameters

Table 72. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Unique Visitors for Last Week

Description

This API returns the count of unique visitors seen in the last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/count/lastweek

Requires OAuth

Parameters

Table 73. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Unique Visitors for Last Month

Description

This API returns the count of unique visitors seen in the last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/count/lastmonth

Requires OAuth

Parameters

Table 74. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Count of Unique Visitors for a Date/Date Range

Description

This API returns the count of unique visitors seen on a day or range of dates.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/count

Requires OAuth

Parameters

Table 75. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
startDate	Y	—	String	query	Start Date
endDate	Y	—	String	query	End Date
date	N	—	String	query	Date

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/visitor/count/?siteId=<Site ID>&date=<date in yyyy-mm-dd>

Sample Output

GET: Sum of Visitor Counts for a Date Range

Description

This API returns the sum of visitor counts for each day in the specified date range.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/total

Requires OAuth

Parameters

Table 76. Parameter Details
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

GET: Sum of Visitor Counts for the Last 3 Days

Description

This API returns the sum of visitor counts for each day in the last 3 days.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/total/3days

Requires OAuth

Parameters

Table 77. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Sum of Visitor Counts for the Last Week

Description

This API returns the sum of visitor counts for each day in the last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/total/lastweek

Requires OAuth

Parameters

Table 78. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Sum of Visitor Counts for the Last Month

Description

This API returns the sum of visitor counts for each day in the last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/total/lastmonth

Requires OAuth

Parameters

Table 79. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Hourly Count of Visitors Today

Description

This API returns the hourly count of visitors today until now.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/hourly/today

Requires OAuth

Parameters

Table 80. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Hourly Count of Visitors Yesterday

Description

This API returns the hourly count of visitors yesterday.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/hourly/yesterday

Requires OAuth

Parameters

Table 81. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site Id

Content Type

application/json

GET: Hourly Count of Visitors for Last 3 Days

Description

This API returns the hourly count of visitors for the last 3 days including today.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/hourly/3days

Requires OAuth

Parameters

Table 82. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site Id

Content Type

application/json

GET: Hourly Count of Visitors for a Day

Description

This API returns the hourly count of visitors for the specified date.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/hourly

Requires OAuth

Parameters

Table 83. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site Id
date	Y	—	String	query	Date

Content Type

application/json

GET: Daily Count of Visitors for a Date Range

Description

This API returns the daily count of unique visitors for the specified date range.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/daily

Requires OAuth

Parameters

Table 84. Parameter Details
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/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 Visitors for Last Week

Description

This API returns the daily count of visitors for the last 7 days including today.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/daily/lastweek

Requires OAuth

Parameters

Table 85. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Daily Count of Visitors for Last Month

Description

This API returns the daily count of visitors for the last 30 days including today.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/daily/lastmonth

Requires OAuth

Parameters

Table 86. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Daily Count of Visitors by Hour Category for a Date Range

Description

This API returns the daily count of visitors seen during morning, business, evening hours for the specified date range.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/daily/hourcategory

Requires OAuth

Parameters

Table 87. Parameter Details
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/visitor/daily/hourcategory/?siteId=<Site ID>&date=<date in 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":{  
      "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
   }
}

GET: Visitor Summary for a Day

Description

This API returns a summary of visitor traffic for the specified date.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/daysummary

Requires OAuth

Parameters

Table 88. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date

Content Type

application/json

GET: Visitor Summary for Week

Description

This API returns a summary of visitor traffic for the week of the specified date.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/weeksummary

Requires OAuth

Parameters

Table 89. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date

Content Type

application/json

GET: Visitor Summary for Month

Description

This API returns a summary of visitor traffic for the month of the specified date.

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/monthsummary

Requires OAuth

Parameters

Table 90. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date

Content Type

application/json

Summary API

GET: Site KPI Summary for Specified Date or Date Range

Description

This API returns the KPI summary for the given site and specified date or date range.

HTTP Method

GET

Resource URI

/api/presence/v1/kpisummary

Requires OAuth

Parameters

Table 91. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	N	—	String	query	Date
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/kpisummary?siteId=<Site ID>&startDate=<date in yyyy-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,
         "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,
         "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"
   }
}

GET: Site KPI Summary for Today

Description

This API returns the KPI summary for the given site today until now.

HTTP Method

GET

Resource URI

/api/presence/v1/kpisummary/today

Requires OAuth

Parameters

Table 92. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Site KPI Summary for Yesterday

Description

This API returns the KPI summary for the given site yesterday.

HTTP Method

GET

Resource URI

/api/presence/v1/kpisummary/yesterday

Requires OAuth

Parameters

Table 93. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Site KPI Summary for Last 3 Days

Description

This API returns the KPI summary for the given site for the last 3 days.

HTTP Method

GET

Resource URI

/api/presence/v1/kpisummary/3days

Requires OAuth

Parameters

Table 94. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Site KPI Summary for last 7 days

Description

This API returns the KPI summary for the given site for the last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/kpisummary/lastweek

Requires OAuth

Parameters

Table 95. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Site KPI Summary for Last 30 Days

Description

This API returns the KPI summary for the given site for the last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/kpisummary/lastmonth

Requires OAuth

Parameters

Table 96. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID

Content Type

application/json

GET: Site Insights for Specified Date or Date Range

Description

This API returns the insights for the given site and specified date or date range.

HTTP Method

GET

Resource URI

/api/presence/v1/insights

Requires OAuth

Parameters

Table 97. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	N	—	String	query	Date
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/insights/?siteId=<Site ID>&startDate=<date in yyyy-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,
      "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,
         "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
      }
   }
}

Clients API

GET: Excluded Client Counts

Description

This API returns the client counts excluded by filters.

HTTP Method

GET

Resource URI

/api/presence/v1/excluded

Requires OAuth

Parameters

Table 98. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	N	—	Number	query	Site ID

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
}

GET: Active Clients

Description

This API returns the active clients seen in the last 20 minutes.

HTTP Method

GET

Resource URI

/api/presence/v1/clients

Requires OAuth

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",
            "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",
            "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,
      "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>

GET: Client Detail

Description

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

Parameters

Table 99. Parameter Details
Name	Required	Default	Type	Location	Description
macaddress	Y	—	String	pathReplace	MAC address
site-id	Y	—	String	pathReplace	Site 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",
            "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,
            "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":{  
            "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",
      "currentApName":null,
      "lastApName":null,
      "lastSiteName":"NOC"
   },
   {  
      "siteEntries":{  
         "1487260407843":

GET: Active Client Counts

Description

This API returns the count of active clients that are currently being tracked.

HTTP Method

GET

Resource URI

/api/presence/v1/clients/count

Requires Basic Auth

Parameters

None.

Content Type

application/json

API History

Table 100. API History
Release	Modification
Cisco CMX Release 10.4	This API is introduced.

Passersby API

GET: Count of Passersby Today

Description

This API returns the count of passersby seen today until now.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/count/today

Requires OAuth

Parameters

Table 101. Parameter Details
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/passerby/count/today?siteId=<Site ID>

Sample Output

Number

GET: Count of Passersby Yesterday

Description

This API returns the count of passersby seen yesterday.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/count/yesterday

Requires OAuth

Parameters

Table 102. Parameter Details
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/passerby/count/yesterday?siteId=<Site ID>

Sample Output

Number

GET: Average Count of Passersby in Last 3 Days

Description

This API returns the average count of passersby seen in the last 3 days.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/count/3days

Parameters

Table 103. Parameter Details
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/passerby/count/3days?siteId=<Site ID>

Sample Output

Number

GET: Average Count of Passersby in the Last 7 days

Description

This API returns the average count of passersby seen in the last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/count/lastweek

Requires OAuth

Parameters

Table 104. Parameter Details
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/passerby/count/lastweek?siteId=<Site ID>

Sample Output

Number

GET: Average Count of Passersby in the Last 30 Days

Description

This API returns the average count of passersby seen in the last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/count/lastmonth

Parameters

Table 105. Parameter Details
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/passerby/count/lastmonth?siteId=<Site ID>

Sample Output

Number

GET: Sum of Passerby Counts in the Specified Date Range

Description

This API returns the sum of passerby counts for each day in the specified date range.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/total

Parameters

Table 106. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
startDate	Y	—	String	query	Start Date in format of yyyy-mm-dd
endDate	Y	—	String	query	End Date in format of yyyy-mm-dd

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/total?siteId=<Site ID>&startDate=yyyy-mm-dd&endDate=yyyy-mm-dd

Sample Output

Number

GET: Sum of Passerby Counts in the Last 3 Days

Description

This API returns the sum of passerby counts for each day in the last 3 days.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/total/3days

Requires OAuth

Parameters

Table 107. Parameter Details
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/passerby/total/3days?siteId=<Site ID>

Sample Output

Number

GET: Sum of Passerby Counts in the Last 7 Days

Description

This API returns the sum of passerby counts for each day in the last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/total/lastweek

Requires OAuth

Parameters

Table 108. Parameter Details
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/passerby/total/lastweek?siteId=<Site ID>

Sample Output

Number

GET: Count of Passersby on a Given Date

Description

This API returns the count of passersby seen on a given day.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/count

Requires OAuth

Parameters

Table 109. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date in format of yyyy-mm-dd

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/count?siteId=<Site ID>&date=<date in yyyy-mm-dd>

Sample Output

Number

GET: Sum of Passerby Counts in the Last 30 days

Description

This API returns the sum of passerby counts for each day in the last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/total/lastmonth

Requires OAuth

Parameters

Table 110. Parameter Details
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/passerby/total/lastmonth?siteId=<Site ID>

Sample Output

Number

GET: Hourly Count of Passersby Today

Description

This API returns the hourly count of passersby today until now.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/hourly/today

Requires OAuth

Parameters

Table 111. Parameter Details
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/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
}

GET: Hourly Count of Passersby Yesterday

Description

This API returns the hourly count of passersby yesterday.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/hourly/yesterday

Requires OAuth

Parameters

Table 112. Parameter Details
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/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
}

GET: Hourly Count of Passersby for Last 3 days

Description

This API returns the hourly count of passersby for the last 3 days including today.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/hourly/3days

Requires OAuth

Parameters

Table 113. Parameter Details
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/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,
      "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
   }
}

GET: Hourly Count of Passersby for a Day

Description

This API returns the hourly count of passersby for the specified date.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/hourly

Requires OAuth

Parameters

Table 114. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
date	Y	—	String	query	Date in format of yyyy-mm-dd

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/hourly?siteId=<Site ID>&date=<date in yyyy-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
}

GET: Daily Count of Passersby for a Specified Date Range

Description

This API returns the daily count of passersby for the specified date range.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/daily

Requires OAuth

Parameters

Table 115. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
startDate	Y	—	String	query	Start Date in yyyy-mm-dd format
endDate	Y	—	String	query	End Date in yyyy-mm-dd format

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/daily?siteId=<Site ID>&startDate=<date in yyyy-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,
   "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
}

GET: Daily Count of Passersby for the Last 7 days

Description

This API returns the daily count of passersby for the last 7 days.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/daily/lastweek

Requires OAuth

Parameters

Table 116. Parameter Details
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/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,
   "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
}

GET: Daily count of passersby for the last 30 days

Description

This API returns the daily count of passersby for the last 30 days.

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/daily/lastmonth

Requires OAuth

Parameters

Table 117. Parameter Details
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/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,
   "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
}

GET: Daily Count of Passersby by hour for the Specified Date Range

Description

This API returns the daily count of passersby by hour category for the specified date range

HTTP Method

GET

Resource URI

/api/presence/v1/passerby/daily/hourcategory

Requires OAuth

Parameters

Table 118. Parameter Details
Name	Required	Default	Type	Location	Description
siteId	Y	—	Number	query	Site ID
startDate	Y	—	String	query	Start Date in yyyy-mm-dd format
endDate	Y	—	String	query	End Date in yyyy-mm-dd format

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/passerby/daily/hourcategory?siteId=<Site ID>&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
   },
   "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,
      "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.5

Bias-Free Language

Results

Chapter: Presence

Presence

Connected Visitors API

GET: Count of Connected Visitors for a Date

Description

HTTP Method

Resource URI

Requires Basic Auth

Parameters

Content Type

Sample Output

GET: Count of Connected Visitors Seen today Until Now

Description

HTTP Method

Resource URI

Requires OAuth

Parameters

Content Type

Usage Guidelines

Sample Output

GET: Count of Connected Visitors Seen Yesterday

Description

HTTP Method

Resource URI

Requires OAuth

Parameters

Content Type

Usage Guidelines

Sample Output

GET: Average Count of Connected Visitors Seen in Last 3 Days

Description

HTTP Method

Resource URI

Requires OAuth

Parameters

Content Type

Usage Guidelines

Sample Output

GET: Average Count of Connected Visitors Seen in Last 7 Days

Description

HTTP Method

Resource URI

Requires OAuth

Parameters

Content Type

Usage Guidelines

Sample Output

GET: Average Count of Connected Visitors seen in last 30 Days

Description

HTTP Method

Resource URI

Requires OAuth

Parameters

Content Type

Usage Guidelines

Sample Output

GET: Sum of Connected Visitor Counts in Last 3 days

Description

HTTP Method

Resource URI

Requires Basic Auth

Parameters

Content Type

Usage Guidelines

Sample Output

GET: Sum of Connected Visitor Counts in Last 7 days

Description

HTTP Method

Resource URI

Requires OAuth

Parameters

Content Type

Usage Guidelines

Sample Output

GET: Sum of Connected Visitor Counts in Last 30 days

Description

HTTP Method