Connect

Widget funnel beacon (fire-and-forget)

A PII-free beacon recording which step of the in-modal connect flow a user reached. It exists because server-side counters only observe connections that actually get created, and so are blind to pre-connection drop-off. step and outcome are allow-listed server-side and anything unrecognised is folded into a fixed label. A beacon that carries a session_id is also stored against the calling application, which is what GET /analytics/connect reads; one without it is only counted. No domain, IP or user agent is stored. It always answers 204, including for an invalid token or a malformed body, so telemetry can never block or error the widget; do not branch on its response.

post/telemetry:connect

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/telemetry:connect
  • Auth: HTTP bearer

Request body

stepstring

Funnel step label (server-side allow-list).

outcomestring

Outcome label (server-side allow-list).

session_idstring

Random id per widget open, 8 to 64 of [A-Za-z0-9_-].

providerstring

Detected DNS provider id.

rail'oauth' | 'domain_connect' | 'manual' | 'api_key' | 'managed_dns'
domain_kind'apex' | 'subdomain'
error_codestring

Widget error code, [A-Za-z0-9_] up to 48.

connection_idstring
elapsed_msinteger

Milliseconds since the widget opened (capped at a day).

Response

Always. Carries no body and reports no error by design.

Changes

No recorded changes to this operation across all 1 revision of this API.