APIs

Get funnel analytics

post
https://reports-api.notifyvisitors.com/api/v1/viewFunnel

This endpoint provides funnel analytics for a given date range. It supports multiple funnel event steps, event-level attribute filters, property filters, breakdowns by event property or segment, and event attribute selection.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body parameters for generating funnel analytics.

date
required

Start date of the date range for which funnel data is required. Value must be specified in YYYY-MM-DD format.

date
required

End date of the date range for which funnel data is required. Value must be specified in YYYY-MM-DD format.

integer
enum

Determines whether users must complete funnel events in the exact defined order. Pass 0 to allow events to occur in any order, or 1 to enforce the specified event order.

Allowed:
filters
array of objects
required

Defines the events used as funnel steps. The order of events in this array determines the funnel step order. Each event can optionally contain attribute filters.

filters*
filters_property
array of objects

Defines additional property-level filters that are applied to the funnel data.

filters_property
conversion_window
object

Defines the conversion window duration and time unit for completing the funnel steps.

string

Attribute used to calculate revenue. It must be an attribute belonging to the last step event of the funnel.

string
enum

Determines how the funnel data should be broken down. Supported values are event_property and segment.

Allowed:
integer
≥ 0

Specifies the funnel step for which data should be returned. Pass 0 for all steps, 1 for step 1, 2 for step 2, and so on.

event_attribute
array of strings

List of event attributes to be included in the funnel analysis or breakdown.

event_attribute
Headers
integer
required

Brand ID of NotifyVisitors account.

string
required

API key of NotifyVisitors.

Responses

Updated 10 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago