Skip to main content
POST
Get funnel

Authorizations

Authorization
string
header
required

An API key (mana_api_...) with scopes. It reads reports and writes profile properties.

Path Parameters

projectId
string<uuid>
required

The project ID

Body

application/json
steps
object[]
required

2 to 5 steps: { "type": "page", "value": "/pricing" } or { "type": "track", "value": "signup" }

Required array length: 2 - 5 elements
date_from
string

First day (UTC) as YYYY-MM-DD. Default: 29 days before date_to.

Pattern: ^\d{4}-\d{2}-\d{2}$
date_to
string

Last day (UTC) as YYYY-MM-DD. Default: today. The range is at most 367 days.

Pattern: ^\d{4}-\d{2}-\d{2}$
page_path
string

Only events on this page path

Maximum string length: 2048
Pattern: ^\/
utm_source
string
Maximum string length: 255
utm_medium
string
Maximum string length: 255
utm_campaign
string
Maximum string length: 255
utm_content
string
Maximum string length: 255
utm_term
string
Maximum string length: 255
ref
string

Referral code (ref link parameter)

Maximum string length: 255
paid_source
enum<string>

Ad network of a paid click

Available options:
google,
meta,
microsoft,
tiktok,
twitter,
linkedin,
reddit,
snapchat,
paid_utm
click_id
string

Ad click ID (gclid, fbclid and others)

Maximum string length: 255
channel_type
enum<string>

Acquisition channel

Available options:
Paid Search,
Paid Video,
Paid Social,
Paid Other,
Email,
Referrals,
Display,
AI,
Organic Search,
Organic Social,
Organic Video,
Referrers,
Direct
referrer
string

Referrer origin, for example https://www.reddit.com

Maximum string length: 2048
locale
string
Maximum string length: 32
device
enum<string>
Available options:
desktop,
mobile,
tablet,
bot
os
enum<string>
Available options:
windows,
macos,
ios,
android,
linux,
other
browser
enum<string>
Available options:
chrome,
safari,
firefox,
edge,
opera,
other
country
string

ISO 3166-1 alpha-2 country code

Pattern: ^[A-Za-z]{2}$
currency
string

Report currency for revenue (ISO 4217). Default: USD.

Pattern: ^[A-Z]{3}$
currency_mode
enum<string>

convert (default) converts other currencies with the rate of the event day. only counts the report currency alone.

Available options:
convert,
only
filters
object[]

Operator filters, combined with AND

Maximum array length: 20
window_seconds
integer

Conversion window in seconds: 1 minute to 90 days. Default: 86400.

Required range: 60 <= x <= 7776000
funnel_type
enum<string>

closed (default) counts visitors who start at step 1. open lets visitors enter at any step.

Available options:
closed,
open
breakdown
string

Split the funnel by an event property or a context field

Pattern: ^[A-Za-z0-9_.:$ -]{1,100}$
breakdown_touch
enum<string>

With breakdown: the value of the first (default) or the last touch

Available options:
first,
last

Response

The report

date_from
string
required

First day of the report

Pattern: ^\d{4}-\d{2}-\d{2}$
date_to
string
required

Last day of the report

Pattern: ^\d{4}-\d{2}-\d{2}$
rows
object[]
required