Get funnel analysis

GET

/v1/projects/{id}/funnels

• Web API (Projects, Maps, Content, Query, Analytics, Alerts, Data)

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.

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Project UUID.

Query Parameters

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.

Responses

200

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

Headers

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.

400

Invalid request parameters or body.

RFC 9457 Problem Details. Served with the application/problem+json media type. error_category, retryable, and retry_after are Framedash extension members. type always defaults to about:blank, so it is always present; detail and the extension members are present only when applicable.

object

type

required

Problem type URI; about:blank when no specific type applies.

string format: uri

default: about:blank

title

required

Short, human-readable summary of the problem type.

string

status

required

HTTP status code.

integer

detail

Human-readable explanation specific to this occurrence.

string

error_category

Extension member categorizing the error.

string

Allowed values: authentication authorization validation rate_limit not_found conflict payload internal

retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean

retry_after

Extension member; suggested retry delay in seconds, when applicable.

integer

401

Missing or invalid API key.

RFC 9457 Problem Details. Served with the application/problem+json media type. error_category, retryable, and retry_after are Framedash extension members. type always defaults to about:blank, so it is always present; detail and the extension members are present only when applicable.

object

type

required

Problem type URI; about:blank when no specific type applies.

string format: uri

default: about:blank

title

required

Short, human-readable summary of the problem type.

string

status

required

HTTP status code.

integer

detail

Human-readable explanation specific to this occurrence.

string

error_category

Extension member categorizing the error.

string

Allowed values: authentication authorization validation rate_limit not_found conflict payload internal

retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean

retry_after

Extension member; suggested retry delay in seconds, when applicable.

integer

404

Resource not found.

RFC 9457 Problem Details. Served with the application/problem+json media type. error_category, retryable, and retry_after are Framedash extension members. type always defaults to about:blank, so it is always present; detail and the extension members are present only when applicable.

object

type

required

Problem type URI; about:blank when no specific type applies.

string format: uri

default: about:blank

title

required

Short, human-readable summary of the problem type.

string

status

required

HTTP status code.

integer

detail

Human-readable explanation specific to this occurrence.

string

error_category

Extension member categorizing the error.

string

Allowed values: authentication authorization validation rate_limit not_found conflict payload internal

retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean

retry_after

Extension member; suggested retry delay in seconds, when applicable.

integer

429

Rate limit exceeded.

RFC 9457 Problem Details. Served with the application/problem+json media type. error_category, retryable, and retry_after are Framedash extension members. type always defaults to about:blank, so it is always present; detail and the extension members are present only when applicable.

object

type

required

Problem type URI; about:blank when no specific type applies.

string format: uri

default: about:blank

title

required

Short, human-readable summary of the problem type.

string

status

required

HTTP status code.

integer

detail

Human-readable explanation specific to this occurrence.

string

error_category

Extension member categorizing the error.

string

Allowed values: authentication authorization validation rate_limit not_found conflict payload internal

retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean

retry_after

Extension member; suggested retry delay in seconds, when applicable.

integer

Headers

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.

Retry-After

integer

Number of seconds to wait before retrying. Present only on 429 responses. Because the limit uses a sliding window, honor this value per response rather than scheduling a retry for the reset time.