Secure sign-in funnel, time per stage and where sessions stop
Secure sign-in funnel, time per stage and where sessions stop: CustomDomain™ API reference. Covers parameters, request body, responses and error codes.
How secure sign-in sessions (the cloud browser) went in the window, overall and per DNS provider. funnel counts the sessions that reached each stage (started, sign-in shown, signed in, plan ready, making changes, done) with the drop from the stage before. times is the median and 90th percentile of the seconds from the stage before it that has a time, over the sessions that reached it; total is start to done for the sessions that finished. stops files every session that ended without finishing under one plain reason (browser_not_started, left_at_sign_in, code_never_entered, provider_page_not_understood, provider_refused, timed_out, cancelled, changes_failed, error). A session finished by hand counts in done_by_hand, a running one in in_progress; neither is in the funnel's done or the stops. Counts and times only: no domain, person or anything typed. Scoped to the key's workspace and app_id when given. At most 20000 sessions are read, newest first (truncated). API key; any member role.
Authorization
apiKey Long-lived tenant API key, cd_live_… (production) or cd_test_… (staging, development), stored hashed. Keys created before the switch to cd_ start with sk_live_… / sk_test_… and are still accepted. Scoped to the owning application's tenant.
In: header
Query Parameters
1 <= value <= 18030Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/analytics/secure-sign-in"{ "window": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z", "days": 0, "application_id": "string" }, "truncated": true, "overall": { "provider": "string", "sessions": 0, "done": 0, "done_by_hand": 0, "in_progress": 0, "stopped": 0, "completion_rate": 0, "funnel": [ { "key": "started", "sessions": 0, "drop": 0, "drop_rate": 0, "of_started": 0 } ], "times": [ { "samples": 0, "median_seconds": 0, "p90_seconds": 0, "key": "sign_in_shown" } ], "total": { "samples": 0, "median_seconds": 0, "p90_seconds": 0 }, "stops": [ { "key": "browser_not_started", "sessions": 0, "share": 0 } ] }, "providers": [ { "provider": "string", "sessions": 0, "done": 0, "done_by_hand": 0, "in_progress": 0, "stopped": 0, "completion_rate": 0, "funnel": [ { "key": "started", "sessions": 0, "drop": 0, "drop_rate": 0, "of_started": 0 } ], "times": [ { "samples": 0, "median_seconds": 0, "p90_seconds": 0, "key": "sign_in_shown" } ], "total": { "samples": 0, "median_seconds": 0, "p90_seconds": 0 }, "stops": [ { "key": "browser_not_started", "sessions": 0, "share": 0 } ] } ]}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}