---
title: "Gets event flow data for Sankey-type visualizations. Builds a chronological sequence of events indicating the path users took through sessions."
method: GET
path: "/adhawk/eventflow"
tags: ["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`
- URL: `https://api.reveldigital.com/adhawk/eventflow`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://id.reveldigital.com/connect/authorize`
    - Token URL: `https://id.reveldigital.com/connect/token` scopes: `webapi`
  - API key in header `X-RevelDigital-ApiKey`
  - 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)

## Query parameters

- `startDate` string, date-time
- `endDate` string, date-time
- `deviceId` string[]
- `eventName` string[]
- `eventDepthLevel` integer
- `limit` integer

## Response `200`

OK

- AdHawkEventFlow[]
  - `source` string, nullable: Source event name with index suffix (e.g., "Button Click1")
  - `target` string, nullable: Target event name with index suffix (e.g., "Page View2")
  - `value` integer: Count of transitions from source to target
  - `event_index` integer: Position in the event sequence (1 = first transition, 2 = second, etc.)
  - `avg_dwell` number, double, nullable: Average dwell time in seconds between source and target events

---

[API](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api.md) - [All operations](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/revisions/39d5c8302822?raw)