GET Get aggregated visitor tracking KPIs for a viewer (Pro)
GET /viewers/{viewerToken}/visitor-tracking-summary: Get aggregated visitor tracking KPIs for a viewer (Pro). Retrieve aggregated visitor tracking KPIs (unique
Are you an LLM? You can read better optimized documentation at /docs/api/endpoints/statistics/get-viewers-viewerToken-visitor-tracking-summary.md for this page in Markdown format
GET
Try it out https://api.rooom.com/viewers/{viewerToken}/visitor-tracking-summaryScopes
viewer.stats:readParameters
Path Parameters
| Name | Type | Description |
|---|---|---|
viewerTokenrequiredExample: _viewerToken_ | string | Viewer token. |
Query Parameters
| Name | Type | Description |
|---|---|---|
startExample: 1746057600 | integer | Start of the time range as a Unix timestamp (inclusive). Must be a valid integer; returns 400 if non-numeric. When omitted, no lower bound is applied. |
endExample: 1748649600 | integer | End of the time range as a Unix timestamp (inclusive). Must be a valid integer; returns 400 if non-numeric. Must not be less than start; returns 400 if start > end. When omitted, no upper bound is applied. |
Responses
200Successfully retrieved visitor tracking KPIs
401Authentication required - Invalid or missing token
403Forbidden - Pro plan (premium or enterprise) required
404Viewer not found
500Internal server error
GET /viewers/{viewerToken}/visitor-tracking-summary Get aggregated visitor tracking KPIs for a viewer (Pro) Retrieve aggregated visitor tracking KPIs (unique visitors, session count, average session duration) for a specific viewer. Requires a Pro plan (premium or enterprise subscription). Optionally filter by time range using Unix timestamp parameters start and end. The frontend is responsible for mapping UI presets (Today, 7 days, 30 days, Custom) to the correct timestamps. Required scopes: viewer.stats:read viewerToken Viewer token. start Start of the time range as a Unix timestamp (inclusive). Must be a valid integer; returns 400 if non-numeric. When omitted, no lower bound is applied. end End of the time range as a Unix timestamp (inclusive). Must be a valid integer; returns 400 if non-numeric. Must not be less than start; returns 400 if start > end. When omitted, no upper bound is applied.