Query Saved Report

get

https://{regionAndDomain}.com/api/query/funnels

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

Query Params

project_id

integer

required

Required if using service account to authenticate request.

workspace_id

integer

The id of the workspace if applicable.

funnel_id

integer

required

The funnel that you wish to get data for.

from_date

string

required

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

to_date

string

required

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

length

integer

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

string

enum

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.

Allowed:

interval

integer

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

unit

string

enum

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

Allowed:

string

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

where

string

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

limit

integer

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

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success