Skip to main content
GET
Get your application's visit identity funnel

Authorizations

X-API-Key
string
header
required

Query Parameters

start_date
string<date> | null

Filter records created on or after this date (format: YYYY-MM-DD).

end_date
string<date> | null

Filter records created on or before this date (format: YYYY-MM-DD).

tz
string
default:UTC

IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

Examples:

"UTC"

"America/Los_Angeles"

"Europe/London"

Response

The identity funnel.

Your application's visits by how far their identity got, each visit counted once, at its stage now, on the day it started in tz.

start_date
string<date> | null
required

The first day counted, in tz; null for none.

end_date
string<date> | null
required

The last day counted, in tz; null for none.

tz
string
required

The IANA zone the days are read in.

stages
VisitIdentityStageCount (v1) · object[]
required

Every stage, anonymous to credentialed, 0 when none.

credentialed_by_level
VisitIdentityLevelCount (v1) · object[]
required

The credentialed visits by identity level, L1 to L3, 0 when none; a credentialed visit with no level is in no row.

total_visit_count
integer
required

Every visit counted.

Required range: x >= 0