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