Skip to main content

Journey Analytics

Journeys

Analyze visitor paths, correlated events, and conversion-oriented journey context.

Audience: Analysts investigating behavioral flows before conversion or abandonment.

Critical: Journey endpoints are site-scoped and require explicit site access verification before data is returned.

Who This Page Is For

Use this page when you need user-path level analysis: listing journeys, inspecting individual paths, exporting journey data, and exploring event correlations.

Quick Start (2-5 Minutes)

1

Get journey stats

Retrieve site-level journey summary for date range.

GET /api/v1/analytics/journeys/:siteId/stats?startDate=2026-01-01&endDate=2026-01-31
2

List journeys

Paginate journeys with conversion filters.

GET /api/v1/analytics/journeys/:siteId?limit=50&offset=0&converted=true
3

Read journey details

Inspect one specific journey and event timeline.

GET /api/v1/analytics/journeys/:siteId/:journeyId
4

Export journeys

Export JSON or CSV for external analysis.

GET /api/v1/analytics/journeys/:siteId/export?format=csv&limit=1000
5

Analyze correlated groups

Inspect grouped co-occurring events for pattern discovery.

GET /api/v1/analytics/correlations/:siteId?limit=20

Journey endpoints

GET /api/v1/analytics/journeys/:siteId/stats
GET /api/v1/analytics/journeys/:siteId/funnel
GET /api/v1/analytics/journeys/:siteId/export
GET /api/v1/analytics/journeys/:siteId/:journeyId
GET /api/v1/analytics/journeys/:siteId
GET /api/v1/analytics/correlations/:siteId

Required Fields / Minimum Payload

FieldRequiredTypeUsed by eventsDescription
siteIdRequireduuidAll journey endpointsSite-level dataset boundary for journey analytics.
journeyIdConditionalstring/uuidJourney detail endpointRequired when fetching a single journey.
startDate / endDateOptionalISO datestats/funnel/export/listDate interval for journey calculations.
limit / offset / convertedOptionalquery paramsJourney list and exportPagination and conversion filtering controls.
formatOptionalcsv | jsonExport endpointExport data format selection.

Event or Endpoint Decision Matrix

ScenarioUse ThisWhy
Need site-level journey health snapshot/analytics/journeys/:siteId/statsReturns summary KPIs quickly.
Need paged journey list with filters/analytics/journeys/:siteIdSupports offset/limit and conversion filtering.
Need one path deep-dive/analytics/journeys/:siteId/:journeyIdEvent-level details for a specific journey.
Need offline analysis in BI tools/analytics/journeys/:siteId/exportCSV/JSON export support.
Need association patterns across events/analytics/correlations/:siteIdHighlights grouped behavior for optimization ideas.

Common Errors and Fixes

Journey list returns empty unexpectedly

Cause: Date range too narrow or converted filter too strict.

Fix: Widen date range and remove converted filter for baseline check.

403 when querying a site

Cause: Authenticated user lacks access to site organization.

Fix: Verify user role and organization-site relationship.

Export payload too large or slow

Cause: Large interval with high limit.

Fix: Use bounded range and chunk exports by date windows.

Correlations hard to interpret

Cause: No event taxonomy grouping in downstream analysis.

Fix: Normalize event categories before interpretation.

Production Checklist

  • Journey endpoints are queried with explicit start/end dates in reporting jobs.Required
  • Large exports are chunked by period to avoid oversized payloads.Required
  • Journey deep-dives are linked to funnel and attribution analyses.Required
  • Site access assumptions are validated in multi-tenant dashboards.Required
  • Correlation findings are reviewed against business context before action.Required

Next Steps