Analytics

Edge traffic for one domain

What the edge served for one connected domain: requests by status class, bytes relayed to visitors, the origin's time to first byte (p50, p95, p99 and mean over the requests that reached it) and approximate unique visitors, as a series with totals, plus when the edge last served a request for it. serving says whether the domain's visitors reach the edge at all: live and verifying are served by the edge; not_live will be once the domain is live; dns_only means its records point somewhere other than the edge (it was connected for DNS only), so its traffic never passes through CustomDomain™ and there is nothing to count. Visitors are estimated from a sketch of keyed hashes of client addresses; no address is stored, and a visitor seen on two UTC days counts once on each. A tenant API key reads a domain of any application in its tenant; a widget token minted with scope app (or a delegated agent token) reads its own application's domains; an end user's connect-scoped widget token is refused.

A delegated agent token needs domains:read.

get/connections/{id}/traffic

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/connections/{id}/traffic
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.customdomain.ai/oauth/agent/authorize, token URL https://api.customdomain.ai/oauth/agent/token, scopes: domains:read)

Path parameters

idstring required

Query parameters

range'24h' | '7d' | '30d' | '90d'

Response

Domain traffic

connection_idstring required
domainstring required
range'24h' | '7d' | '30d' | '90d' required
granularity'hour' | 'day' required
fromstring date-time required

Start of the first bucket.

tostring date-time required

End of the last bucket (exclusive); the last bucket is the current one.

last_request_atstring date-time nullable required

End of the last minute in which the edge served this domain; null when never (within retention).

Changes

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