v1

latestOpenAPI 3.0.3MIT2026-07-26104113247.1 KB
Funnels

Query Saved Report

Get data for a funnel. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

get/funnels

Query parameters

project_idinteger required

Required if using service account to authenticate request.

workspace_idinteger

The id of the workspace if applicable.

funnel_idinteger required

The funnel that you wish to get data for.

from_datestring required

The date in yyyy-mm-dd format to begin querying from. This date is inclusive.

to_datestring required

The date in yyyy-mm-dd format to query to. This date is inclusive.

lengthinteger

The number of units (defined by length_unit) each user has to complete the funnel, starting from the time they triggered the first step in the funnel. May not be greater than 90 days. Note that we will query for events past the end of to_date to look for funnel completions. This defaults to the value that was previously saved in the UI for this funnel.

length_unit'day' | 'hour' | 'minute' | 'second'

The unit applied to the length parameter can be "second", "minute", "hour", or "day". Defaults to the value that was previously saved in the UI for this funnel.

Example:day
intervalinteger

The number of days you want each bucket to contain. The default value is 1.

unit'day' | 'week' | 'month'

This is an alternate way of specifying interval and can be "day", "week", or "month".

onstring

The property expression to segment the event on. See the expression to segment below.

wherestring

An expression to filter events by. See the expression to segment below.

limitinteger

Return the top property values. Defaults to 255 if not explicitly included. Maximum value 10,000. This parameter does nothing if "on" is not specified.

Response

Success

dataobject