{
"id": "space.highport.manage.getSiteTraffic",
"defs": {
"main": {
"type": "query",
"errors": [
{
"name": "InvalidDomain",
"description": "Not a syntactically valid, non-reserved, public-suffix-safe domain. Distinct from DomainNotFound: the string is not a hostname at all."
},
{
"name": "DomainNotFound",
"description": "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."
},
{
"name": "AnalyticsDisabled",
"description": "This deployment has no analytics store configured, so no traffic was ever recorded."
}
],
"output": {
"schema": {
"type": "object",
"required": [
"domain",
"bytesBilled",
"bytesBilledToVisitors",
"headerEstimateBytes",
"buckets",
"topPaths",
"statuses"
],
"properties": {
"domain": {
"type": "string"
},
"buckets": {
"type": "array",
"items": {
"type": "object",
"required": [
"bucket",
"requests",
"bytesBody",
"bytesBilled"
],
"properties": {
"bucket": {
"type": "string",
"format": "datetime",
"description": "The hour this bucket starts."
},
"requests": {
"type": "integer",
"description": "Responses in the hour."
},
"bytesBody": {
"type": "integer",
"description": "Response body bytes, as the edge logged them."
},
"bytesBilled": {
"type": "integer",
"description": "Body bytes plus the per-response header estimate."
}
},
"description": "One hour of a domain's traffic."
},
"description": "Hourly buckets, oldest first."
},
"statuses": {
"type": "array",
"items": {
"type": "object",
"required": [
"status",
"requests",
"bytesBilled",
"botRequests"
],
"properties": {
"status": {
"type": "integer",
"description": "The HTTP status."
},
"requests": {
"type": "integer",
"description": "Responses with this status."
},
"botRequests": {
"type": "integer",
"description": "How many of those came from a client classified as a crawler. Crawler traffic is billed, because it is real egress and the alternative rewards user-agent spoofing."
},
"bytesBilled": {
"type": "integer",
"description": "Billed bytes."
}
},
"description": "One status code's share of the requests and of the bytes."
},
"description": "The status mix, with the crawler share alongside it."
},
"topPaths": {
"type": "array",
"items": {
"type": "object",
"required": [
"path",
"requests",
"bytesBilled"
],
"properties": {
"path": {
"type": "string",
"description": "The request path."
},
"requests": {
"type": "integer",
"description": "Responses."
},
"bytesBilled": {
"type": "integer",
"description": "Billed bytes."
}
},
"description": "One path and what it cost."
},
"description": "The busiest paths over the range."
},
"bytesBilled": {
"type": "integer",
"description": "Total billed bytes over the range."
},
"headerEstimateBytes": {
"type": "integer",
"description": "The flat per-response constant added to every logged body size. Every byte figure here is an estimate by this much per response."
},
"bytesBilledToVisitors": {
"type": "integer",
"description": "How much of bytesBilled an authenticated visitor paid for rather than the owner. Zero unless the domain is on the sender-pays policy."
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"required": [
"domain"
],
"properties": {
"to": {
"type": "string",
"format": "datetime",
"description": "Exclusive upper bound. Defaults to now."
},
"from": {
"type": "string",
"format": "datetime",
"description": "Inclusive lower bound. Defaults to 30 days ago."
},
"domain": {
"type": "string",
"maxLength": 253,
"description": "The registered hostname. Must be registered to the calling identity."
},
"topPaths": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 0,
"description": "How many of the busiest paths to return."
}
}
},
"description": "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."
}
},
"$type": "com.atproto.lexicon.schema",
"lexicon": 1
}