Skip to main content

Events API

/events exposes event-level lead and sale rows for troubleshooting conversion pipelines and customer journeys.

Endpoint

Query parameters

Response shape

  • data: array of event rows
  • meta.page: current page
  • meta.limit: page size
  • meta.hasMore: pagination hint for next-page loading

Permissions and availability

  • Requires workspace auth.
  • Requires links:read permission.
  • If analytics backend is unavailable, endpoint returns 503.

Caching behavior

Read responses are snapshot-cached for short TTL windows to reduce repeated analytics fetches while preserving near-real-time usability.

Typical failures

  • 400 BAD_REQUEST: invalid type
  • 503 SERVICE_UNAVAILABLE: analytics service not configured
  • 500 ANALYTICS_ERROR: upstream analytics query failure
Related docs:
  • /user-guides/manual/data/events-and-customers-operations-reference
  • /user-guides/manual/data/exports-and-operational-checks
  • /user-guides/manual/data/analytics-and-reporting