space.highport.manage.getSiteTraffic
Traffic to one of the caller's domains over a time range: hourly requests and bytes, the busiest paths, and status codes. Byte figures include a fixed per-response header estimate, since the edge logs only response bodies.
Details · query
| Kind | query |
|---|---|
| Authority | manage.highport.space |
| Indexed |
Query
query · GETParameters
query stringThe registered hostname. Must belong to the caller.
maxLength: 253
from
string · datetimeInclusive lower bound. Defaults to 30 days ago.
to
string · datetimeExclusive upper bound. Defaults to now.
topPaths
integerHow many of the busiest paths to return.
minimum: 0maximum: 100default: 20
topRecords
integerHow many record versions to return. A domain republished often has many, so this is a top N, not the full history.
minimum: 0maximum: 100default: 20
Output
application/jsonHourly buckets, oldest first.
One hour of a domain's traffic.
Total bytes billed over the range.
The part of bytesBilled that signed-in visitors paid instead of the owner. Zero unless the domain uses the visitor payer policy.
The fixed per-response header estimate added to each logged body size. Every byte figure here is estimated by this much per response.
records
arrayWhich versions of the site record served the traffic, heaviest first. Limited to topRecords, so a frequently republished domain may have versions not listed. Absent if the deployment does not report it.
One published version and the traffic it served.
refusals
objectWhat the bandwidth allowance refused over the range, and what serving it would have cost. Absent if the deployment does not report it.
Requests by status code, with the crawler share.
One status code's share of requests and bytes.
The busiest paths over the range.
One path and its traffic.
Errors
InvalidDomain
Not a valid, non-reserved, public-suffix-safe domain. Unlike DomainNotFound, the input is not a hostname at all.
DomainNotFound
No such domain, or it does not belong to the caller. Both cases get the same error, so it cannot be used to check whether a domain exists.
AnalyticsDisabled
No analytics store is configured, so no traffic was recorded.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
Identities that signed in to one of the caller's domains, and what each spent there. Anonymous traffic is not listed, and no query links a visitor across domains.
-
Domains ranked by successful, non-crawler requests over a trailing window. Safe to publish: a domain is left out if it is not serving, has a malware finding, or is denylisted in any way (directly, by pattern, or through its identity, space, record or serving CID). Counts can lag by up to ten minutes.