Get session funnel

GET

https://devapi.withverifa.com/api/v1/analytics/funnel

GET

/api/v1/analytics/funnel

$ curl https://devapi.withverifa.com/api/v1/analytics/funnel \
>      -H "X-API-Key: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "stages": [
3     {
4       "name": "created",
5       "label": "Sessions Created",
6       "count": 1200,
7       "drop_off_count": 300,
8       "drop_off_pct": 25,
9       "completion_pct": 100
10     },
11     {
12       "name": "started_capture",
13       "label": "Capture Started",
14       "count": 900,
15       "drop_off_count": 200,
16       "drop_off_pct": 22.2,
17       "completion_pct": 75
18     },
19     {
20       "name": "submitted",
21       "label": "Submitted",
22       "count": 700,
23       "drop_off_count": 150,
24       "drop_off_pct": 17.1,
25       "completion_pct": 58.3
26     },
27     {
28       "name": "completed",
29       "label": "Completed",
30       "count": 550,
31       "drop_off_count": 0,
32       "drop_off_pct": null,
33       "completion_pct": 45.8
34     }
35   ],
36   "summary": {
37     "total_created": 1200,
38     "completed": 550,
39     "failed": 100,
40     "expired": 50,
41     "overall_completion_rate": 45.8
42   },
43   "days": 30
44 }

Returns the session funnel with stage-by-stage counts and drop-off percentages. Stages: created → started_capture → submitted → completed.

Required scope: sessions:read

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Query parameters

daysintegerOptional7-90Defaults to 30

Response

Funnel stages with drop-off.

stageslist of objects

summaryobject

daysinteger

Errors

401

Unauthorized Error

Authentication

Headers

Query parameters

Response

Errors