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

N

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

3

GET: Count of Connected Visitors Seen today Until Now

Description

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

HTTP Method

GET

Resource URI

/api/presence/v1/connected/count/today

Requires OAuth

N

Parameters

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

107

GET: Sum of Visitor Counts for a Date Range

Description

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

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/total

Requires OAuth

N

Parameters

Table 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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

Parameters

None.

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/excluded?siteId=<Site ID>

Sample Output

[  
   {  
      "siteEntries":{  
         "1487056035936":{  
            "macAddress":"ac:c3:3a:87:5c:79",
            "status":"PASSERBY",
            "siteId":1487056035936,
            "siteName":"PSL NOC",
            "firstRssiTime":1488360873407,
            "lastRssiTime":1488360873407,
            "lastMarkedPasserBy":1488360873407,
            "firstMarkedVisitor":0,
            "lastMarkedVisitor":0,
            "firstMarkedAssociated":0,
            "lastMarkedAssociated":0,
            "lastInfoTime":0,
            "rssi":-83,
            "currentApMacAddress":"00:2a:10:f8:87:50",
            "currentApName":null,
            "lastApMacAddress":null,
            "lastApName":null,
            "controller":"10.222.175.13",
            "firstRssiTimeStamp":"2017-03-01 09:34:407",
            "lastRssiTimeStamp":"2017-03-01 09:34:407",
            "lastMarkedPasserByTimeStamp":"2017-03-01 09:34:407",
            "firstMarkedVisitorTimeStamp":"null",
            "lastMarkedVisitorTimeStamp":"null",
            "lastMarkedAssociatedTimeStamp":"null",
            "firstMarkedAssociatedTimeStamp":"null",
            "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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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

N

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
   }
}

GET: Count of Passersby Today

Description

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

HTTP Method

GET

Resource URI

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

Requires OAuth

N

Parameters

Table 119. 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

N

Parameters

Table 120. 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 121. 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

N

Parameters

Table 122. 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 123. 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 124. 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

N

Parameters

Table 125. 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

N

Parameters

Table 126. 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

N

Parameters

Table 127. 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

N

Parameters

Table 128. 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

N

Parameters

Table 129. 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

N

Parameters

Table 130. 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

N

Parameters

Table 131. 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

N

Parameters

Table 132. 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

N

Parameters

Table 133. 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

N

Parameters

Table 134. 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

N

Parameters

Table 135. 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

N

Parameters

Table 136. 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
   }
}

GET: Excluded Client Counts

Description

This API returns the client counts excluded by filters.

HTTP Method

GET

Resource URI

/api/presence/v1/excluded

Requires OAuth

N

Parameters

Table 137. 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

N

Parameters

None.

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/excluded?siteId=<Site ID>

Sample Output

[  
   {  
      "siteEntries":{  
         "1487056035936":{  
            "macAddress":"ac:c3:3a:87:5c:79",
            "status":"PASSERBY",
            "siteId":1487056035936,
            "siteName":"PSL NOC",
            "firstRssiTime":1488360873407,
            "lastRssiTime":1488360873407,
            "lastMarkedPasserBy":1488360873407,
            "firstMarkedVisitor":0,
            "lastMarkedVisitor":0,
            "firstMarkedAssociated":0,
            "lastMarkedAssociated":0,
            "lastInfoTime":0,
            "rssi":-83,
            "currentApMacAddress":"00:2a:10:f8:87:50",
            "currentApName":null,
            "lastApMacAddress":null,
            "lastApName":null,
            "controller":"10.222.175.13",
            "firstRssiTimeStamp":"2017-03-01 09:34:407",
            "lastRssiTimeStamp":"2017-03-01 09:34:407",
            "lastMarkedPasserByTimeStamp":"2017-03-01 09:34:407",
            "firstMarkedVisitorTimeStamp":"null",
            "lastMarkedVisitorTimeStamp":"null",
            "lastMarkedAssociatedTimeStamp":"null",
            "firstMarkedAssociatedTimeStamp":"null",
            "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

N

Parameters

Table 138. 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: Count of Connected Visitors for a Date

Description

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

HTTP Method

GET

Resource URI

/api/presence/v1/connected/count

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

Requires Basic Auth

N

Parameters

Table 139. 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

3

GET: Count of Connected Visitors Seen today Until Now

Description

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

HTTP Method

GET

Resource URI

/api/presence/v1/connected/count/today

Requires OAuth

N

Parameters

Table 140. 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

N

Parameters

Table 141. 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

N

Parameters

Table 142. 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

N

Parameters

Table 143. 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

N

Parameters

Table 144. 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

N

Parameters

Table 145. 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

N

Parameters

Table 146. 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

N

Parameters

Table 147. 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

N

Parameters

Table 148. 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

N

Parameters

Table 149. 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

N

Parameters

Table 150. 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

N

Parameters

Table 151. 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

N

Parameters

Table 152. 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

N

Parameters

Table 153. 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

N

Parameters

Table 154. 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

N

Parameters

Table 155. 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

N

Parameters

Table 156. 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
   }
}

GET: Site KPI Summary for Specified Date or Date Range

Description

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

HTTP Method

GET

Resource URI

/api/presence/v1/kpisummary

Requires OAuth

N

Parameters

Table 157. 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

N

Parameters

Table 158. 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

N

Parameters

Table 159. 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

N

Parameters

Table 160. 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

N

Parameters

Table 161. 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

N

Parameters

Table 162. 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

N

Parameters

Table 163. 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
      }
   }
}

GET: Average Count of Repeat Visitors for Last 7 Days

Description

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

HTTP Method

GET

Resource URI

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

Requires OAuth

N

Parameters

Table 164. 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

N

Parameters

Table 165. 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

N

Parameters

Table 166. 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

N

Parameters

Table 167. 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

N

Parameters

Table 168. 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

N

Parameters

Table 169. 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

N

Parameters

Table 170. 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

N

Parameters

Table 171. 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

N

Parameters

Table 172. 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

N

Parameters

Table 173. 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

N

Parameters

Table 174. 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

N

Parameters

Table 175. 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

N

Parameters

Table 176. 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

N

Parameters

Table 177. 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

N

Parameters

Table 178. 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

N

Parameters

Table 179. 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

N

Parameters

Table 180. 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

N

Parameters

Table 181. 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

N

Parameters

Table 182. 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

N

Parameters

Table 183. Parameter Details

Name

Required

Default

Type

Location

Description

siteId

Y

—

Number

query

Site ID

Content Type

application/json

GET: Peak Hour of Visitors Today

Description

This API returns the hour that had peak visitors today.

HTTP Method

GET

Resource URI

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

Requires OAuth

N

Parameters

Table 184. 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

N

Parameters

Table 185. 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

N

Parameters

Table 186. 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

N

Parameters

Table 187. 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

N

Parameters

Table 188. 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

N

Parameters

Table 189. 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

N

Parameters

Table 190. 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

107

GET: Sum of Visitor Counts for a Date Range

Description

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

HTTP Method

GET

Resource URI

/api/presence/v1/visitor/total

Requires OAuth

N

Parameters

Table 191. 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

N

Parameters

Table 192. 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

N

Parameters

Table 193. 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

N

Parameters

Table 194. 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

N

Parameters

Table 195. 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

N

Parameters

Table 196. 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

N

Parameters

Table 197. 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

N

Parameters

Table 198. 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

N

Parameters

Table 199. 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

N

Parameters

Table 200. 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

N

Parameters

Table 201. 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

N

Parameters

Table 202. 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

N

Parameters

Table 203. 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

N

Parameters

Table 204. 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

N

Parameters

Table 205. Parameter Details

Name

Required

Default

Type

Location

Description

siteId

Y

—

Number

query

Site ID

date

Y

—

String

query

Date

Content Type

application/json

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

Description

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

HTTP Method

GET

Resource URI

/api/presence/v1/dwell/count

Requires OAuth

N

Parameters

Table 206. 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

N

Parameters

Table 207. 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

N

Parameters

Table 208. 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

N

Parameters

Table 209. 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

N

Parameters

Table 210. 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

N

Parameters

Table 211. 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

N

Parameters

Table 212. 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

N

Parameters

Table 213. 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

N

Parameters

Table 214. 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

N

Parameters

Table 215. 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

N

Parameters

Table 216. 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

N

Parameters

Table 217. 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

N

Parameters

Table 218. 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

N

Parameters

Table 219. 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

N

Parameters

Table 220. 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

N

Parameters

Table 221. 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

N

Parameters

Table 222. 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

N

Parameters

Table 223. 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

N

Parameters

Table 224. 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

N

Parameters

Table 225. 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

N

Parameters

Table 226. 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

N

Parameters

Table 227. 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

N

Parameters

Table 228. 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

N

Parameters

Table 229. 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

N

Parameters

Table 230. 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

N

Parameters

Table 231. 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

N

Parameters

Table 232. 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

N

Parameters

Table 233. 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

N

Parameters

Table 234. 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

N

Parameters

Table 235. Parameter Details

Name

Required

Default

Type

Location

Description

siteId

Y

—

Number

query

Site ID

Content Type

application/json

GET: Return Loaded Instances

Description

This API returns all tenant instances loaded in this node.

HTTP Method

GET

Resource URI

/api/presence/v1/debug/tenants/allinstances

Requires OAuth

N

Parameters

None.

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/debug/tenants/allinstances

Sample Output

[  
   "com.cisco.cmx.presence.cache.ApCache-0",
   "com.cisco.cmx.presence.cache.ApCache-1000",
   "com.cisco.cmx.presence.cache.ApCache-1001",
   "com.cisco.cmx.presence.cache.ApCache-1002",
   "com.cisco.cmx.presence.cache.ApCache-1003",
   "com.cisco.cmx.presence.cache.ApCache-1004",
   "com.cisco.cmx.presence.cache.ApCache-1005",
   "com.cisco.cmx.presence.cache.ApCache-1006",
   "com.cisco.cmx.presence.cache.ApCache-1007",
   "com.cisco.cmx.presence.cache.ApCache-1008",
   "com.cisco.cmx.presence.cache.ApCache-1009",
   "com.cisco.cmx.presence.cache.ApCache-1010",
   "com.cisco.cmx.presence.cache.ApCache-1011",
   "com.cisco.cmx.presence.cache.ApCache-1012",
   "com.cisco.cmx.presence.cache.ApCache-1013",
   "com.cisco.cmx.presence.cache.ApCache-1014",
   "com.cisco.cmx.presence.cache.ApCache-1015",
   "com.cisco.cmx.presence.cache.ApCache-1016",
   "com.cisco.cmx.presence.cache.ApCache-1017",
   "com.cisco.cmx.presence.cache.ApCache-1018",
   "com.cisco.cmx.presence.cache.ApCache-1019",
   "com.cisco.cmx.presence.cache.ApCache-102",
   "com.cisco.cmx.presence.cache.ApCache-1020",
   "com.cisco.cmx.presence.cache.ApCache-1021",
   "com.cisco.cmx.presence.cache.ApCache-1022",
   "com.cisco.cmx.presence.cache.ApCache-1023",
   "com.cisco.cmx.presence.cache.ApCache-1024",
   "com.cisco.cmx.presence.cache.ApCache-1025",
   "com.cisco.cmx.presence.cache.ApCache-1026",
   "com.cisco.cmx.presence.cache.ApCache-1027",
   "com.cisco.cmx.presence.cache.ApCache-1028",
   "com.cisco.cmx.presence.cache.ApCache-1029",
   "com.cisco.cmx.presence.cache.ApCache-103",
   "com.cisco.cmx.presence.cache.ApCache-1030",
   "com.cisco.cmx.presence.cache.ApCache-1031",
   "com.cisco.cmx.presence.cache.ApCache-1032",
   "com.cisco.cmx.presence.cache.ApCache-1033",
   "com.cisco.cmx.presence.cache.ApCache-1034",
   "com.cisco.cmx.presence.cache.ApCache-1035",
   "com.cisco.cmx.presence.cache.ApCache-1036",
   "com.cisco.cmx.presence.cache.ApCache-1037",
   "com.cisco.cmx.presence.cache.ApCache-1039",
   "com.cisco.cmx.presence.cache.ApCache-104",
   "com.cisco.cmx.presence.cache.ApCache-1040",
   "com.cisco.cmx.presence.cache.ApCache-1041",
   "com.cisco.cmx.presence.cache.ApCache-1042",
   "com.cisco.cmx.presence.cache.ApCache-1043",
   "   com.cisco.cmx.presence.cache.ApCache-

API History

Table 236. API History

Release

Modification

Cisco CMX Release 10.3

This API is introduced.

GET: Loaded instances for the Tenant

Description

This API returns the tenant instances loaded in this node

HTTP Method

GET

Resource URI

/api/presence/v1/debug/tenants/instances

Requires OAuth

N

Parameters

None.

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/debug/tenants/instances

Sample Output

[  
   "com.cisco.cmx.presence.cache.ApCache",
   "com.cisco.cmx.presence.cache.ClientCache",
   "com.cisco.cmx.presence.cache.LiveApCache",
   "com.cisco.cmx.presence.cache.MetricsCache",
   "com.cisco.cmx.presence.cache.SiteCache",
   "com.cisco.cmx.presence.cache.SiteParamsCache",
   "com.cisco.cmx.presence.db.ConnectedDataProcessor",
   "com.cisco.cmx.presence.db.DwellDataProcessor",
   "com.cisco.cmx.presence.db.ManufacturerDataProcessor",
   "com.cisco.cmx.presence.db.MonthlyInsightsDataProcessor",
   "com.cisco.cmx.presence.db.PasserbyDataProcessor",
   "com.cisco.cmx.presence.db.RepeatVisitorDataProcessor",
   "com.cisco.cmx.presence.db.VisitorDataProcessor",
   "com.cisco.cmx.presence.db.WeeklyInsightsDataProcessor",
   "com.cisco.cmx.presence.model.Counters",
   "com.cisco.cmx.presence.persistence.InsightDataService",
   "com.cisco.cmx.presence.persistence.PresenceAggregator",
   "com.cisco.cmx.presence.persistence.PresenceDataService",
   "com.cisco.cmx.presence.service.PresencePdfGenerator",
   "com.cisco.mse.notifications.NotificationRuntime"
]

API History

Table 237. API History

Release

Modification

Cisco CMX Release 10.3

This API is introduced.

GET: Returns Tenants which have Data Loaded

Description

This API returns all tenants which have instances loaded in this node.

HTTP Method

GET

Resource URI

/api/presence/v1/debug/tenants

Requires Basic Auth

N

Parameters

None.

Content Type

application/json

API History

Table 238. API History

Release

Modification

Cisco CMX Release 10.3

This API is introduced.

DELETE: get all tenants which have data loaded

Description

This API returns all tenants which have instances loaded in this node

HTTP Method

DELETE

Resource URI

/api/presence/v1/debug/tenants

Requires OAuth

N

Parameters

None.

Content Type

application/json

GET: get all tenants which have data loaded

Description

This API returns all tenants which have instances loaded in this node

HTTP Method

GET

Resource URI

/api/debug/v1/tenants

Requires OAuth

N

Parameters

None.

Content Type

application/json

DELETE: get all tenants which have data loaded

Description

This API returns all tenants which have instances loaded in this node

HTTP Method

DELETE

Resource URI

/api/debug/v1/tenants

Requires OAuth

N

Parameters

None.

Content Type

application/json

DELETE: get all tenants which have data loaded

Description

This API returns all tenants which have instances loaded in this node

HTTP Method

DELETE

Resource URI

/api/presence/v1/debug/tenants

Requires OAuth

N

Parameters

None.

Content Type

application/json

GET: Client Detail

Description

This API returns the client MAC and number sites.

HTTP Method

GET

Resource URI

/api/presence/v1/clients/site

Requires OAuth

N

Parameters

None.

Content Type

application/json

Usage Guidelines

https://<tenant-id>.cmxcisco.com/api/presence/v1/clients/site

Sample Output

{  
   "98:0c:a5:63:3d:30":1,
   "3c:bb:fd:a2:99:b7":1,
   "28:c2:dd:57:f4:db":1,
   "88:a7:3c:96:68:2a":1,
   "ac:9e:17:c5:0e:27":1,
   "d4:0b:1a:3e:c9:12":1,
   "9c:5c:8e:aa:96:c0":1,
   "dc:f1:10:ab:81:2b":1,
   "04:56:04:b0:38:af":1,
   "88:79:7e:3f:fd:11":1,
   "e0:2c:b2:fe:61:16":1,
   "c0:ee:fb:31:b9:b7":1,
   "68:c4:4d:3b:77:14":1,
   "20:02:1b:c0:3d:b2":1,
   "a4:70:d6:3c:be:d3":1,
   "38:a4:ed:d0:9d:ad":1,
   "64:09:80:ca:0f:d6":1,
   "e8:50:8b:ed:c7:c0":1,
   "18:dc:56:f0:33:f6":1,
   "c8:f2:30:e0:7a:f9":1,
   "64:cc:2e:93:4f:e7":1,
   "00:ae:fa:75:9d:d3":1,
   "a4:70:d6:7f:c7:67":1,
   "44:d4:e0:5c:cc:26":1,
   "48:5a:3f:49:23:f2":1,
   "bc:6e:64:7e:04:07":1,
   "88:79:7e:16:36:21":1,
   "00:17:7c:2c:49:b5":1,
   "c4:3a:be:4b:07:c1":1,
   "6c:5c:14:fa:82:19":1,
   "c0:ee:fb:56:3e:bb":1,
   "74:e2:8c:18:38:00":1,
   "f8:84:f2:8f:61:8a":1,
   "48:5a:3f:56:33:95":1,
   "ac:c3:3a:be:fc:b5":1,
   "38:a4:ed:c4:05:c7":1,
   "ec:df:3a:13:91:6e":1,
   "e0:2c:b2:c7:13:14":1,
   "00:27:10:5f:c7:4c":1,
   "68:c4:4d:86:3c:52":1,
   "14:1a:a3:8f:8e:fc":1,
   "1c:8e:5c:55:90:c0":1,
   "60:f1:89:04:c8:f8":1,
   "50:55:27:f5:29:b8":1,
   "00:c2:c6:7f:1b:65":1,
   "1c:56:fe:02:42:9e":1,
   "58:44:98:b4:91:b6":1,
   "c4:66:99:f7:e1:fa":1,
   "c0:ee:fb:31:ed:23":1,
   "2c:5a:05:23:dc:54":1,
   "48:5a:3f:10:52:6e":1,
   "10:d3:8a:9c:8c:2b":1,
   "60:67:20:bd:84:74":1,
   "74:04:2b:0e:56:2d":1,
   "b0:e2:35:57:97:93":1,
   "9c:6c:15:ef:6d:7c":1,
   "14:1a:a3:96:f3:c1":1,
   "a0:93:47:89:0b:18":1,
   "50:c8:e5:c1:18:09":1,
   "c8:f2:30:db:11:0b":1,
   "68:fb:7e:4c:b3:88":1,
   "70:4d:7b:08:29:51":1,
   "64:cc:2e:98:a1:eb":1,
   "e4:f8:ef:4b:73:d3":1,
   "54:14:73:e0:6e:76":1,
   "48:13:7e:51:2f:a4":1,
   "58:48:22:38:15:1b":1,
   "48:9d:24:3e:12:50":1,
   "94:92:bc:45:c9:d3":1,
   "ac:c3:3a:bc:e1:85":1,
   "cc:c3:ea:3e:7f:c8":1,
   "00:27:10:5b:d0:38":1,
   "68:c4:4d:16:4c:39":1,
   "00:08:22:5e:e6:75":1,
   "84:10:0d:a0:a2:ca":1,
   "80:6c:1b:ea:b1:ea":1,
   "bc:79:ad:4e:cc:b5":1,
   "c0:9f:05:6e:99:60":1,
   "1c:39:47:48:ed:a6":1,
   "60:67:20:a4:32:32":1,
   "34:97:f6:ad:8a:ff":1,
   "d4:0b:1a:63:9c:46":1,
   "60:7e:dd:85:8b:80":1,
   "24:df:6a:63:c2:53":1,
   "cc:61:e5:43:e2:9d":1,
   "dc:ce:bc:ac:1a:a3":1,
   "e8:50:8b:4a:14:de":1,
   "24:da:9b:1f:d9:93":1,
   "68:48:98:01:93:9a":1,
   "e4:5d:75:95:ed:ef":1,
   "68:48:98:ea:bb:2b":1,
   "cc:79:4a:fc:4b:37":1,
   "ac:c3:3a:93:70:88":1,
   "bc:6e:64:92:ca:e2":1,
   "74:e2:8c:d6:1a:d8":1,
   "90:e7:c4:01:ff:bb":1,
   "88:79:7e:90:c3:ae":1,
   "88:79:7e:7e:22:3c":1,
   "98:0c:a5:d3:34:9a":1,
   "c8:d7:79:29:81:e0":1,
   "50:c8:e5:ab:a9:45":1,
   "2c:8a:72:b2:cc:95":1,
   "a4:70:d6:4e:99:f8":1,
   "cc:61:e5:b6:c0:3b":1,
   "64:db:43:a8:4c:b8":1,
   "04:56:04:a9:b3:a2":1,
   "f4:f5:24:5d:63:04":1,
   "1c:56:fe:9c:0e:41":1,
   "e4:5d:75:98:fe:c6":1,
   "3c:91:57:35:a2:0d":1,
   "ac:c1:ee:a0:00:3b":1,
   "b0:e2:35:56:01:87":1,
   "84:8e:df:86:52:1c":1,
   "a0:88:b4:24:e4:9c":1,
   "ac:c1:ee:ad:94:7d":1,
   "dc:6d:cd:e2:00:85":1,
   "7c:0b:c6:b3:17:3f":1,
   "ac:c3:3a:b8:49:66":1,
   "64:cc:2e:96:4a:69":1,
   "ac:c3:3a:54:70:a4":1,
   "1c:56:fe:00:b2:c6":1,
   "54:a0:50:63:de:17":1,
   "14:f6:5a:ee:10:4c":1,
   "cc:61:e5:28:48:e4":1,
   "fc:3d:93:76:a8:5e":1,
   "94:ce:2c:79:f7:20":1,
   "e4:a4:71:fb:40:69":1,
   "cc:61:e5:eb:f7:18":1,
   "90:21:81:38:a1:78":1,
   "d4:ca:6d:ab:d3:09":1,
   "6c:88:14:f2:35:d4":1,
   "c0:9f:05:70:c5:fa":1,
   "c0:11:73:db:a3:27":1,
   "18:dc:56:f0:bf:2c":1,
   "98:0c:a5:d2:7b:95":1,
   "44:80:eb:24:17:7c":1,
   "f4:f5:24:b1:6c:e0":1,
   "7c:1d:d9:55:5c:c8":1,
   "3c:bb:fd:9c:9b:26":1,
   "74:23:44:35:5f:e7":1,
   "ac:c1:ee:b4:ee:f3":1,
   "60:7e:dd:7b:77:06":1,
   "d4:0b:1a:66:fc:7f":1,
   "c4:56:fe:c2:f0:62":1,
   "24:da:9b:a7:eb:a6":1,
   "e0:98:61:6d:c4:78":1,
   "80:01:84:27:85:d7":1,
   "48:88:ca:70:7f:77":1,
   "44:80:eb:6e:79:02":1,
   "b8:5e:7b:e0:ec:e0":1,
   "6c:88:14:85:ba:4c":1,
   "f4:f5:24:00:d6:c1":1,
   "40:78:6a:e5:1f:c8":1,
   "00:16:6d:10:2f:83":1,
   "40:c6:2a:6a:d9:bf":1,
   "24:0a:64:b6:14:6f":1,
   "a4:70:d6:50:ba:ed":1,
   "00:08:22:66:81:1d":1,
   "ac:c3:3a:33:8a:25":1,
   "cc:61:e5:43:29:6c":1,
   "64:db:43:4e:ca:c2":1,
   "18:89:5b:54:6c:7a":1,
   "b0:e2:35:5d:ac:e7":1,
   "90:e7:c4:01:78:88":1,
   "64:db:43:a9:c8:cc":1,
   "30:5a:3a:9a:10:66":1,
   "88:79:7e:85:2d:71":1,
   "2c:8a:72:95:23:ad":1,
   "f4:f5:24:1e:7e:04":1,
   "18:3d:a2:a6:a2:80":1,
   "ac:c3:3a:4b:f2:c1":1,
   "f8:01:13:33:fd:c0":1,
   "ac:c1:ee:b9:77:a5":1,
   "20:10:7a:65:e8:7c":1,
   "38:a4:ed:58:8b:3d":1,
   "80:6c:1b:a8:cf:92":1,
   "70:4d:7b:08:c3:1d":1,
   "bc:d1:1f:e5:9e:d0":1,
   "a4:e4:b8:24:52:a8":1,
   "ac:c1:ee:5b:22:9b":1,
   "64:cc:2e:14:74:39":1,
   "18:cf:5e:38:77:ae":1,
   "c0:ee:fb:df:2a:c1":1,
   "38:a4:ed:60:43:3d":1,
   "88:79:7e:7c:fb:e9":1,
   "8c:77:16:61:65:58":1,
   "18:dc:56:f0:96:36":1,
   "44:04:44:e4:75:9e":1,
   "a0:00:00:01:4c:6f":1,
   "a0:86:c6:08:ef:00":1,
   "68:c4:4d:6f:d3:5b":1,
   "5c:2e:59:88:5d:1f":1,
   "c0:9f:05:68:01:a9":1,
   "54:27:58:c9:1c:16":1,
   "44:d4:e0:44:d2:5b":1,
   "60:67:20:97:bf:10":1,
   "70:0b:c0:b6:f7:59":1,
   "3c:91:57:9b:c8:c1":1,
   "d0:17:c2:3f:39:ce":1,
   "1c:56:fe:9d:7d:5b":1,
   "d0:df:9a:d2:cb:6b":1,
   "dc:1a:c5:61:7a:6f":1,
   "7c:0b:c6:ab:21:a1":1,
   "a0:88:b4:61:e1:5c":1,
   "fc:64:ba:01:98:c1":1,
   "18:cf:5e:fd:5c:19":1,
   "58:94:6b:7c:ce:bc":1,
   "bc:3a:ea:47:d0:4c":1,
   "04:1b:ba:a9:3c:6a":1,
   "94:d7:71:ab:95:5e":1,
   "1c:cd:e5:04:a3:26":1,
   "c8:f2:30:d9:17:39":1,
   "00:ee:bd:16:3d:ec":1,
   "44:d4:e0:47:3d:05":1,
   "dc:1a:c5:bf:12:a7":1,
   "c0:ee:fb:de:e5:13":1,
   "e8:50:8b:3f:4e:aa":1,
   "c4:9a:02:52:7d:4e":1,
   "dc:6d:cd:eb:ec:95":1,
   "38:a4:ed:5b:2f:1b":1,
   "c0:9f:05:6d:aa:90":1,
   "bc:25:e0:92:05:d8":1,
   "04:c2:3e:e3:64:ad":1,
   "54:14:73:59:00:6e":1,
   "d8:e5:6d:7f:58:e0":1,
   "00:08:22:4e:c5:fb":1,
   "98:0c:a5:41:85:6a":1,
   "60:67:20:97:bf:f2":1,
   "e4:5d:75:16:83:e8":1,
   "4c:66:41:1a:be:fe":1,
   "ec:5a:86:45:e3:d4":1,
   "7c:0b:c6:bf:d6:01":1,
   "e0:98:61:49:69:54":1,
   "44:91:db:0c:af:d2":1,
   "00:ee:bd:12:34:ae":1,
   "ac:c1:ee:be:0b:d7":1,
   "cc:2d:83:f0:e9:ee":1,
   "9c:d3:5b:28:a6:84":1,
   "34:31:11:72:2e:73":1,
   "bc:d1:1f:76:81:6a":1,
   "1c:56:fe:18:5c:f0":1,
   "ac:c3:3a:e0:82:ea":1,
   "bc:6e:64:e4:6f:53":1,
   "94:92:bc:c7:70:11":1,
   "e4:b0:21:ce:70:ab":1,
   "74:51:ba:69:4a:11":1,
   "30:10:b3:72:78:13":1,
   "a0:32:99:74:4b:0f":1,
   "40:49:0f:7a:40:6f":1,
   "c0:ee:fb:80:37:39":1,
   "e4:a4:71:3c:fb:04":1,
   "e0:98:61:86:a6:5a":1,
   "60:67:20:40:20:60":1,
   "64:cc:2e:91:a0:9b":1,
   "84:10:0d:53:94:c7":1,
   "e0:98:61:48:7c:1d":1,
   "18:cf:5e:38:c8:5d":1,
   "68:05:71:9e:3a:37":1,
   "f8:16:54:f9:48:22":1,
   "1c:b7:2c:59:25:9d":1,
   "dc:e8:38:2b:cf:a8":1,
   "98:0c:a5:40:a8:3d":1,
   "8c:70:5a:65:71:94":1,
   "e8:15:0e:dc:9a:57":1,
   "38:a4:ed:c7:7a:25":1,
   "2c:59:8a:51:f1:1f":1,
   "b0:e2:35:56:92:15":1,
   "c0:ee:fb:f3:a7:3c":1,
   "88:79:7e:82:70:3c":1,
   "e0:db:10:88:31:58":1,
   "ac:c3:3a:e3:69:1f":1,
   "5c:e0:c5:ca:42:d9":1,
   "74:23:44:35:ae:ff":1,
   "b0:e2:35:59:31:b5":1,
   "e8:4e:84:7b:db:a1":1,
   "64:db:43:b6:01:75":1,
   "f4:f5:24:af:5d:ac":1,
   "5c:93:a2:b8:61:69":1,
   "d4:8f:33:b5:35:5c":1,
   "f4:f5:24:1d:54:35":1,
   "c0:ee:fb:d7:60:6a":1,
   "1c:56:fe:17:3f:b4":1,
   "5c:e0:c5:c9:a8:ba":1,
   "64:cc:2e:13:7a:49":1,
   "cc:61:e5:42:25:11":1,
   "dc:1a:c5:9f:b0:f7":1,
   "30:5a:3a:bb:36:73":1,
   "20:64:32:3a:dc:ad":1,
   "cc:2d:83:f0:92:07":1,
   "ac:fd:ec:ae:f5:53":1,
   "e0:06:e6:cb:ab:0d":1,
   "5c:51:88:7c:7d:9f":1,
   "64:db:43:49:b6:64":1,
   "98:0c:a5:b8:82:85":1,
   "1c:56:fe:02:26:8d":1,
   "68:05:71:fb:3e:19":1,
   "60:21:c0:f8:74:c1":1,
   "bc:d1:d3:16:09:c8":1,
   "30:75:12:b0:a1:a9":1,
   "1c:56:fe:db:1b:ac":1,
   "7c:1d:d9:4c:40:24":1,
   "bc:d1:1f:7a:44:70":1,
   "34:bb:26:0c:c0:0a":1,
   "d4:9a:20:b6:56:fb":1,
   "ac:c1:ee:70:20:5b":1,
   "a4:70:d6:89:71:ef":1,
   "40:49:0f:01:96:a5":1,
   "48:d2:24:db:d9:57":1,
   "1c:56:fe:97:8f:46":1,
   "0c:b3:19:ad:8f:1d":1,
   "1c:56:fe:03:cf:1f":1,
   "84:10:0d:07:8a:14":1,
   "e8:50:8b:54:e9:01":1,
   "dc:1a:c5:27:de:dd":1,
   "20:d7:5a:02:1a:81":1,
   "80:7a:bf:46:34:5a":1,
   "bc:d1:1f:80:82:2f":1,
   "34:97:f6:0d:dc:ce":1,
   "e4:a4:71:f3:12:45":1,
   "c0:ee:fb:52:22:74":1,
   "6c:2f:2c:71:e0:53":1,
   "18:cf:5e:38:78:0f":1,
   "2c:8a:72:95:eb:78":1,
   "b0:c5:59:ee:42:1a":1,
   "48:88:ca:bd:d1:bc":1,
   "88:79:7e:bd:fa:43":1,
   "7c:1d:d9:44:14:f9":1,
   "dc:6d:cd:ec:07:de":1,
   "84:3a:4b:54:88:cc":1,
   "ac:c1:ee:bb:28:fd":1,
   "dc:1a:c5:12:ac:2d":1,
   "30:0d:43:37:63:f8":1,
   "80:01:84:3d:f6:4d":1,
   "40:88:05:67:a6:08":1,
   "e8:91:20:90:19:4f":1,
   "dc:1a:c5:27:fb:3d":1,
   "90:21:81:58:21:61":1,
   "54:27:58:c9:9f:85":1,
   "e0:98:61:73:a6:91":1,
   "3c:bb:fd:9e:ed:5d":1,
   "9c:35:eb:86:b0:19":1,
   "ac:c3:3a:85:cb:3f":1,
   "6c:88:14:3b:d6:5c":1,
   "30:a8:db:69:cf:24":1,
   "dc:1a:c5:46:89:eb":1,
   "bc:3a:ea:86:8a:f3":1,
   "18:dc:56:f0:9e:35":1,
   "90:68:c3:2a:cd:ea":1,
   "a0:39:f7:17:fd:93":1,
   "14:f6:5a:f6:ba:04":1,
   "bc:3a:ea:83:5d:64":1,
   "80:56:f2:b3:1d:ad":1,
   "98:0c:a5:43:a7:96":1,
   "c0:9f:05:61:38:09":1,
   "88:79:7e:41:f2:7a":1,
   "dc:e8:38:93:ac:68":1,
   "9c:d2:1e:d4:e7:fd":1,
   "e4:5d:75:aa:07:df":1,
   "80:7a:bf:70:eb:80":1,
   "80:6c:1b:32:f6:d0":1,
   "e4:5d:75:51:70:55":1,
   "dc:1a:c5:8f:8e:07":1,
   "bc:92:6b:0d:75:d7":1,
   "98:0c:a5:d2:a5:cb":1,
   "e4:5d:75:e2:53:cf":1,
   "88:a7:3c:e2:24:7a":1,
   "84:38:38:2c:82:6c":1,
   "e0:98:61:87:55:2a":1,
   "cc:2d:83:f4:34:88":1,
   "88:79:7e:65:98:4c":1,
   "3c:91:57:43:ad:c2":1,
   "00:6f:64:54:a0:82":1,
   "80:6c:1b:61:63:19":1,
   "1c:cb:99:a0:9f:bb":1,
   "08:ec:a9:e1:d2:aa":1,
   "ac:5a:14:91:02:6f":1,
   "44:80:eb:2a:a5:a7":1,
   "bc:d1:1f:81:c9:7e":1,
   "68:05:71:c1:02:56":1,
   "84:7a:88:64:da:77":1,
   "44:d4:e0:bf:be:41":1,
   "64:cc:2e:8d:e6:81":1,
   "e4:5d:75:16:8b:56":1,
   "60:fe:1e:94:ea:2e":1,
   "ac:5f:3e:31:cd:08":1,
   "e0:cb:ee:55:e9:70":1,
   "58:48:22:53:3c:30":1,
   "ec:df:3a:20:73:f8":1,
   "a8:7c:01:d2:1d:6f":1,
   "f8:95:c7:aa:e1:ae":1,
   "e4:5d:75:51:b6:8f":1,
   "80:6c:1b:49:97:02":1,
   "90:21:81:48:ec:66":1,
   "e8:50:8b:99:a7:0e":1,
   "e0:98:61:24:d9:37":1,
   "00:6f:64:74:26:51":1,
   "a0:39:f7:2c:89:88":1,
   "60:67:20:3a:e3:38":1,
   "80:6c:1b:cc:aa:34":1,
   "64:bc:0c:6a:e2:b3":1,
   "88:30:8a:72:fd:3e":1,
   "cc:2d:83:f0:92:8f":1
}

API History

Table 239. API History

Release

Modification

Cisco CMX Release 10.3

This API is introduced.