CustomDomain Docs
ReferenceAPI referenceAnalytics

Connect funnel and connection outcomes

Connect funnel and connection outcomes: CustomDomain™ API reference in the analytics group. Covers parameters, request body, responses and error codes.

GET
/analytics/connect

The widget funnel (sessions, how many entered a domain, were offered a one-click or sign-in rail, were shown records to copy, succeeded, where the rest stopped, per provider and root versus subdomain) and connection outcomes (live rate, time to live, per provider and method, why the rest are stuck), plus a daily series. audience counts the widget sessions by device type, country, browser, operating system and embed (no address, no city, no session listed), install whether the widget was seen in the builder's own product or only in the console's tests (per application), and secure_sign_in the cloud browser sessions started in the window: the funnel per provider, the failures by reason, and the same with and without a vendor proxy. Both are scoped like the rest, to the key's workspace and app_id when given. API key; any member role.

AuthorizationBearer <token>

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

days?integer
Range1 <= value <= 180
Default30
app_id?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/analytics/connect"
{  "window": {    "from": "2019-08-24T14:15:22Z",    "to": "2019-08-24T14:15:22Z",    "days": 0,    "application_id": "string"  },  "widget": {    "sessions": 0,    "entered_domain": 0,    "analyzed": 0,    "offered_automatic": 0,    "shown_manual": 0,    "succeeded": 0,    "succeeded_automatic": 0,    "errored": 0,    "conversion_rate": 0,    "median_seconds_to_success": 0,    "drop_off": [      {        "key": "string",        "count": 0      }    ],    "errors": [      {        "key": "string",        "count": 0      }    ],    "providers": [      {        "provider": "string",        "sessions": 0,        "succeeded": 0,        "automatic": 0      }    ],    "domain_kinds": [      {        "kind": "string",        "sessions": 0,        "succeeded": 0      }    ]  },  "connections": {    "total": 0,    "live": 0,    "pending": 0,    "propagating": 0,    "failed": 0,    "live_rate": 0,    "median_seconds_to_live": 0,    "by_provider": [      {        "provider": "string",        "total": 0,        "live": 0,        "pending": 0,        "failed": 0,        "top_stuck": "string",        "top_stuck_count": 0,        "median_seconds_to_live": 0      }    ],    "by_method": [      {        "key": "string",        "total": 0,        "live": 0,        "median_seconds_to_live": 0      }    ],    "by_kind": [      {        "key": "string",        "total": 0,        "live": 0,        "median_seconds_to_live": 0      }    ],    "stuck": [      {        "key": "string",        "count": 0      }    ],    "time_to_live": [      {        "key": "string",        "count": 0      }    ]  },  "daily": [    {      "date": "string",      "sessions": 0,      "succeeded": 0,      "created": 0,      "went_live": 0    }  ],  "audience": {    "sessions": 0,    "devices": [      {        "key": "string",        "sessions": 0,        "succeeded": 0,        "went_live": 0      }    ],    "countries": [      {        "key": "string",        "sessions": 0,        "succeeded": 0,        "went_live": 0      }    ],    "browsers": [      {        "key": "string",        "sessions": 0,        "succeeded": 0,        "went_live": 0      }    ],    "systems": [      {        "key": "string",        "sessions": 0,        "succeeded": 0,        "went_live": 0      }    ],    "embeds": [      {        "key": "string",        "sessions": 0,        "succeeded": 0,        "went_live": 0      }    ]  },  "install": {    "applications": [      {        "application_id": "string",        "product_sessions": 0,        "test_sessions": 0,        "window_product_sessions": 0,        "window_test_sessions": 0,        "last_product_at": "2019-08-24T14:15:22Z",        "last_product_host": "string",        "last_test_at": "2019-08-24T14:15:22Z"      }    ]  },  "secure_sign_in": {    "sessions": 0,    "signed_in": 0,    "done": 0,    "done_manual": 0,    "sign_in_rate": 0,    "average_seconds_to_sign_in": 0,    "average_seconds_to_done": 0,    "providers": [      {        "provider": "string",        "sessions": 0,        "signed_in": 0,        "planned": 0,        "applied": 0,        "done": 0,        "done_manual": 0      }    ],    "failures": [      {        "key": "string",        "sessions": 0,        "with_proxy": 0,        "without_proxy": 0,        "proxy_sensitive": true      }    ],    "proxy": [      {        "proxy": true,        "sessions": 0,        "signed_in": 0,        "done": 0,        "blocked": 0,        "sign_in_rate": 0,        "blocked_rate": 0      }    ]  },  "truncated": true}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}