space.highport.admin.listTopSites

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Domains ranked by successful, non-crawler request count over a trailing window. A popularity signal and nothing more, but one that is safe to publish: a domain that is not serving, that is denylisted directly or by pattern or through its identity, its space, its record or its serving CID, or that carries any malware finding, never appears. Answered from an hourly rollup that trails real time by up to ten minutes, which is invisible at this window's scale.",
      "errors": [
        {
          "description": "This deployment has no analytics store configured, so no traffic was ever recorded. Distinct from an empty list, which means the window held no traffic worth ranking.",
          "name": "AnalyticsDisabled"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "sites": {
              "items": {
                "ref": "#topSite",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "sites"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "days": {
            "default": 7,
            "description": "Length of the trailing window, in days, ending now.",
            "maximum": 30,
            "minimum": 1,
            "type": "integer"
          },
          "limit": {
            "default": 20,
            "description": "Maximum sites to return. Fewer come back when the window holds fewer ranked domains that are safe to show.",
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "minRequests": {
            "default": 0,
            "description": "Floor under the ranked figure, so a near-dead domain cannot rank on a quiet window.",
            "minimum": 0,
            "type": "integer"
          }
        },
        "type": "params"
      },
      "type": "query"
    },
    "topSite": {
      "description": "One domain's standing in the window, and the identity of what is published there.",
      "properties": {
        "botRequests": {
          "description": "Crawler responses in the window, at every status, reported beside the ranked figure rather than folded into it — the same split getSiteTraffic's status mix reports, so a caller can see what was excluded.",
          "type": "integer"
        },
        "domain": {
          "description": "The hostname.",
          "type": "string"
        },
        "recordCid": {
          "description": "The record version the serving snapshot was built from, which is how a later run tells a republished site from unchanged bytes. Absent when the domain is serving without an active snapshot.",
          "format": "cid",
          "type": "string"
        },
        "requests": {
          "description": "Responses in the window that were 2xx and not classified as a crawler. This is the figure the ranking is on: a showcase ranks what people read, so bytes do not decide it, an error loop cannot win it, and a scraper cannot either.",
          "type": "integer"
        },
        "siteDid": {
          "description": "The registration's owner.",
          "format": "did",
          "type": "string"
        }
      },
      "required": [
        "domain",
        "requests",
        "botRequests",
        "siteDid"
      ],
      "type": "object"
    }
  },
  "id": "space.highport.admin.listTopSites",
  "lexicon": 1
}