AdHawk

Gets event flow data for Sankey-type visualizations. Builds a chronological sequence of events indicating the path users took through sessions.

get/adhawk/eventflow

Request

Base URL
https://api.reveldigital.com
Auth
- OAuth 2
  Authorization codehttps://id.reveldigital.com/connect/authorize
  Token URLhttps://id.reveldigital.com/connect/token
  Scopeswebapi
- or API key in header X-RevelDigital-ApiKey
- or API key in query parameter api_key
TypeScript
https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/docs/adhawk/eventflow/get.ts
A function with typed inputs. Its response is checked against the schema.

startDatestring date-time

Start date for the query (required)

endDatestring date-time

End date for the query (required)

deviceIdstring[]

Optional list of device IDs to filter by

eventNamestring[]

Optional list of event names to filter by

eventDepthLevelinteger

Maximum depth level for event flow (default: 6)

limitinteger

Maximum number of results (default: 1000, max: 10000)

sourcestring nullable

Source event name with index suffix (e.g., "Button Click1")

targetstring nullable

Target event name with index suffix (e.g., "Page View2")

valueinteger

Count of transitions from source to target

event_indexinteger

Position in the event sequence (1 = first transition, 2 = second, etc.)

avg_dwellnumber double nullable

Average dwell time in seconds between source and target events

No recorded changes to this operation across all 3 revisions of this API.