API

Dashboard Analytics API

Dashboard analytics routes use the signed-in dashboard session cookie and website team permissions. They are useful for first-party dashboard views and internal product surfaces. Use /api/v1/analytics/* when you need API-key access from another server.

Endpoints

Method	Route	Purpose
GET	/api/websites/{websiteId}/events	Event stream with cursor and `since` polling
GET	/api/websites/{websiteId}/events/properties	Event property keys, values, sessions, and visitors
GET	/api/websites/{websiteId}/events/outbound	Outbound links derived from explicit outbound events and external click hrefs
GET	/api/websites/{websiteId}/journeys	Common page paths through sessions
GET	/api/websites/{websiteId}/retention	Day or week user retention cohorts
GET	/api/websites/{websiteId}/users	Visitor and identified-user list
GET	/api/websites/{websiteId}/users/{userId}	One user or visitor timeline
GET	/api/websites/{websiteId}/errors	Grouped tracked error events
GET	/api/websites/{websiteId}/performance	Web-vitals score, dimensions, and p50/p75/p90/p99 values

Shared filters

Dashboard routes accept the same date and dimension filters used by the dashboard: from, to, country, region, city, referrer, source, device_type, browser, os, utm_source, utm_medium, utm_campaign, utm_term, utm_content, page, entry_page, and hostname where relevant.

Event properties

The response groups scalar property values and includes event, session, and visitor counts. Object values are ignored except for identity traits, which are stored on the user profile.

bash

curl "https://app.revlly.com/api/websites/YOUR_WEBSITE_ID/events/properties?event_name=auto_click&property_key=text" \  -H "Cookie: YOUR_DASHBOARD_SESSION_COOKIE"

Outbound links

The response includes the destination URL, host, click count, unique sessions, unique visitors, last click time, and top source pages.

bash

curl "https://app.revlly.com/api/websites/YOUR_WEBSITE_ID/events/outbound?from=2026-05-01&to=2026-05-12" \  -H "Cookie: YOUR_DASHBOARD_SESSION_COOKIE"

Journeys

Use steps_filter with comma-separated path patterns, or step_1, step_2, and so on, to focus on journeys that start with specific paths. * works as a wildcard.

bash

curl "https://app.revlly.com/api/websites/YOUR_WEBSITE_ID/journeys?steps=5&limit=25" \  -H "Cookie: YOUR_DASHBOARD_SESSION_COOKIE"

Retention

identity=effective uses identified_user_id when present and falls back to the anonymous visitor ID. Use identity=identified to include only known users.

bash

curl "https://app.revlly.com/api/websites/YOUR_WEBSITE_ID/retention?mode=week&identity=effective" \  -H "Cookie: YOUR_DASHBOARD_SESSION_COOKIE"

Users

The list endpoint returns user IDs, linked visitor IDs, sessions, pageviews, non-pageview events, latest device/location attributes, and stored traits for identified users.

bash

curl "https://app.revlly.com/api/websites/YOUR_WEBSITE_ID/users?identity=effective&q=pro" \  -H "Cookie: YOUR_DASHBOARD_SESSION_COOKIE"

Errors

Errors appear only when your app sends event_type: "error" or a custom integration records them. The tracker keeps automatic browser error capture out of the default bundle budget; explicit error tracking can be added through your app or a future optional plugin.