Skip to main content
GET
Get conversion funnel metrics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

Organization ID

Example:

"org-abc123"

Query Parameters

to
string

ISO-8601 end date (inclusive). Omit for no upper bound.

Example:

"2026-02-01T23:59:59.999Z"

from
string

ISO-8601 start date (inclusive). Omit for no lower bound.

Example:

"2026-01-01T00:00:00.000Z"

Response

Conversion funnel metrics

sessions
number
required

Number of sessions observed in the period.

Example:

5000

purchases
number
required

Number of purchases observed in the period.

Example:

250

conversionRate
number | null

Conversion rate (purchases / sessions). null when no sessions were observed in the period — clients should render an empty state ("No data yet") rather than 0.

Example:

0.05