space.highport.admin.listUserAgents

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "agent": {
      "description": "One user agent's share of the window.",
      "properties": {
        "clientClass": {
          "description": "What the classifier made of this agent.",
          "knownValues": [
            "bot",
            "browser",
            "unknown"
          ],
          "type": "string"
        },
        "domains": {
          "description": "How many distinct domains it reached.",
          "type": "integer"
        },
        "lastSeen": {
          "description": "The most recent response to this agent.",
          "format": "datetime",
          "type": "string"
        },
        "requests": {
          "description": "Responses to this agent in the window, at any status.",
          "type": "integer"
        },
        "userAgent": {
          "description": "The User-Agent as sent, cut to 512 bytes. Absent for requests that sent none, and for requests logged before the edge recorded agents.",
          "maxLength": 512,
          "type": "string"
        }
      },
      "required": [
        "clientClass",
        "requests",
        "domains",
        "lastSeen"
      ],
      "type": "object"
    },
    "main": {
      "description": "User agents that reached the network over a trailing window, with request counts and how each was classified, for reviewing crawlers, bots and automation. Operator only. Names no visitor: agents are grouped across all traffic, and the domain count is a number, never a list. Read from raw request events, so the window cannot reach past raw retention (30 days by default).",
      "errors": [
        {
          "description": "No analytics store is configured, so no traffic was recorded.",
          "name": "AnalyticsDisabled"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "agents": {
              "items": {
                "ref": "#agent",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "agents"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "clientClass": {
            "description": "Only return agents the classifier put in this class.",
            "knownValues": [
              "bot",
              "browser",
              "unknown"
            ],
            "type": "string"
          },
          "days": {
            "default": 7,
            "description": "How many days back the window reaches from now.",
            "maximum": 30,
            "minimum": 1,
            "type": "integer"
          },
          "domain": {
            "description": "Only count requests to this hostname.",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "description": "Maximum agents to return, busiest first.",
            "maximum": 200,
            "minimum": 1,
            "type": "integer"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "space.highport.admin.listUserAgents",
  "lexicon": 1
}