Skip to main content
POST
Run a funnel query

Restrictions

Usage

  • start_time and end_time are Unix epoch milliseconds. Omit both to use the last 7 days; a range wider than 14 days returns InvalidParameter.
  • The caller needs read access to application_id; data of private applications the caller cannot access is not counted.
  • compare splits the funnel by its two most frequent values and returns them in groups; without it groups is an empty array.
  • steps[].duration_p50 is null for the first step and when no ordered path was found.
  • A query that times out or queues too long returns a client error; narrow the window or the steps.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Run a funnel definition and optionally split it by a dimension.

application_id
string
required

RUM application ID. The caller needs read access to it; for write operations, manage access.

definition
object
required

Funnel definition: the ordered steps, the counting unit and optional filters. 2 to 10 steps.

compare
enum<string>

Split the funnel by this dimension and return its two most frequent values. Omit for the overall funnel only. Dimension to split by: env, version, device_type, browser_name, os_name or geo_country — the columns shared by the views and actions tables.

Available options:
env,
version,
device_type,
browser_name,
os_name,
geo_country
end_time
integer<int64>

End of the window, Unix timestamp in milliseconds. Defaults to now when omitted.

Example:

1780358400000

start_time
integer<int64>

Start of the window, Unix timestamp in milliseconds. Omit both bounds to use the last 7 days; a range wider than 14 days is rejected.

Example:

1780272000000

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Overall funnel outcome plus the split by the compare dimension.