コンテンツにスキップ

Get funnel analysis

GET
/v1/projects/{id}/funnels

Performs funnel analysis on a sequence of events. Returns step-by-step conversion rates showing how many unique players completed each step within the specified time window.

id
required
string format: uuid

Project UUID.

steps
required
string

Comma-separated list of event names defining funnel steps (2-8 steps).

Example
player.spawn,player.death,player.respawn
window
integer
default: 86400
Allowed values: 3600 21600 86400 604800

Maximum time in seconds between first and last step for a player to count.

days
integer
default: 30
Allowed values: 7 14 30 90

Time period in days.

Array of funnel steps with conversion rates.

object
success
boolean
data
Array<object>
object
step

1-indexed step number in the funnel.

integer
event_name

Event name for this step.

string
count

Number of unique players who reached this step.

integer
pct

Percentage of step-1 players who reached this step.

number
drop_off_pct

Drop-off percentage from the previous step.

number
X-RateLimit-Limit
integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining
integer

Number of requests remaining in the current window.

X-RateLimit-Reset
integer

Unix timestamp when the rate limit window resets.

Invalid request parameters or body.

object
success
boolean
error

Human-readable error message.

string

Missing or invalid API key.

object
success
boolean
error

Human-readable error message.

string

Resource not found.

object
success
boolean
error

Human-readable error message.

string

Rate limit exceeded.

object
success
boolean
error

Human-readable error message.

string
X-RateLimit-Limit
integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining
integer

Number of requests remaining in the current window.

X-RateLimit-Reset
integer

Unix timestamp when the rate limit window resets.