API Reference
Flows
Multi-screen user journeys captured as ordered sequences.
A Flow is an ordered list of Screens representing a complete user journey — onboarding, checkout, paywall conversion, etc.
List flows
GET /api/v1/flows| Name | Type | Description |
|---|---|---|
appId | string | Filter by app |
type | string | Flow type (onboarding, paywall, checkout, …) |
platform | IOS | ANDROID | WEB | Platform filter; lowercase URL tokens are accepted and normalized |
Get a flow
GET /api/v1/flows/:idReturns the flow plus its ordered list of screen objects (full payload, not just IDs).
Flow object
type Flow = {
id: string
appId: string
type: string // 'onboarding'
name: string // 'New user onboarding'
description?: string
screenIds: string[] // ordered
screens?: Screen[] // present on GET /flows/:id
capturedAt: string
}