Lexicon Garden

space.highport.manage.getSiteTraffic

Traffic to one domain the caller owns, over a range: requests and bytes per hour, the busiest paths, and the status mix. Byte figures include a flat per-response header estimate, because the edge's access log records the response body only.

Repository @lexicons.highport.space did:plc:ciygg5hma4q7ah2kxaszkyob namespace authority
Details · query
Kindquery
Authoritymanage.highport.space
Indexed

Showing version bafyreiebijv5ixkrgdnb6nkdmrdyyuouhrlf4ipd7h5tfapirg3u4pf3fm. Show the latest

Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

domain

requiredstring

The registered hostname. Must be registered to the calling identity.

  • maxLength: 253

from

string · datetime

Inclusive lower bound. Defaults to 30 days ago.

to

string · datetime

Exclusive upper bound. Defaults to now.

topPaths

integer

How many of the busiest paths to return.

  • minimum: 0
  • maximum: 100
  • default: 20

topRecords

integer

How many published record versions to return. A record CID is not a small set: a domain republished often has one per publish, so this is a top-N and not the whole history.

  • minimum: 0
  • maximum: 100
  • default: 20

Output

application/json

buckets

requiredarray

Hourly buckets, oldest first.

itemsobject

One hour of a domain's traffic.

bytesBilled

requiredinteger

Total billed bytes over the range.

bytesBilledToVisitors

requiredinteger

How much of bytesBilled an authenticated visitor paid for rather than the owner. Zero unless the domain is on the sender-pays policy.

domain

requiredstring

headerEstimateBytes

requiredinteger

The flat per-response constant added to every logged body size. Every byte figure here is an estimate by this much per response.

records

array

Which published version of the site record served the traffic, heaviest first. Bounded by topRecords, so a domain republished more often than that has versions this does not list. Absent from a deployment that does not report the split.

itemsobject

One published version, and the traffic the snapshots built from it served.

refusals

object

What the bandwidth allowance refused over the range, and what serving it would have cost. Absent from a deployment that does not report it.

statuses

requiredarray

The status mix, with the crawler share alongside it.

itemsobject

One status code's share of the requests and of the bytes.

topPaths

requiredarray

The busiest paths over the range.

itemsobject

One path and what it cost.

Errors

InvalidDomain

Not a syntactically valid, non-reserved, public-suffix-safe domain. Distinct from DomainNotFound: the string is not a hostname at all.

DomainNotFound

No such domain, or it is not registered to the calling identity. The two are one answer so the method is not an existence oracle.

AnalyticsDisabled

This deployment has no analytics store configured, so no traffic was ever recorded.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • space.highport.manage.listSiteVisitors

    query

    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.

  • space.highport.admin.listTopSites

    query

    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.