space.highport.admin.listUserAgents

lexicons.highport.space

Documentation

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).

main query

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).

Parameters

clientClass string Optional

Only return agents the classifier put in this class.

days integer Optional

How many days back the window reaches from now.

domain string Optional

Only count requests to this hostname.

limit integer Optional

Maximum agents to return, busiest first.

Output

Encodingapplication/json
agents array Required

No description available.

Errors

AnalyticsDisabled No analytics store is configured, so no traffic was recorded.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Only return agents the classifier put in this class.
How many days back the window reaches from now.
Only count requests to this hostname.
Maximum agents to return, busiest first.
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "AnalyticsDisabled",
      "description": "No analytics store is configured, so no traffic was recorded."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "agents"
      ],
      "properties": {
        "agents": {
          "type": "array",
          "items": {
            "ref": "#agent",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "days": {
        "type": "integer",
        "default": 7,
        "maximum": 30,
        "minimum": 1,
        "description": "How many days back the window reaches from now."
      },
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 200,
        "minimum": 1,
        "description": "Maximum agents to return, busiest first."
      },
      "domain": {
        "type": "string",
        "description": "Only count requests to this hostname."
      },
      "clientClass": {
        "type": "string",
        "description": "Only return agents the classifier put in this class.",
        "knownValues": [
          "bot",
          "browser",
          "unknown"
        ]
      }
    }
  },
  "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)."
}
agent object

One user agent's share of the window.

Properties

clientClass string Required

What the classifier made of this agent.

Known values: bot, browser, unknown
domains integer Required

How many distinct domains it reached.

lastSeen string datetime Required

The most recent response to this agent.

requests integer Required

Responses to this agent in the window, at any status.

userAgent string Optional

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 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "clientClass",
    "requests",
    "domains",
    "lastSeen"
  ],
  "properties": {
    "domains": {
      "type": "integer",
      "description": "How many distinct domains it reached."
    },
    "lastSeen": {
      "type": "string",
      "format": "datetime",
      "description": "The most recent response to this agent."
    },
    "requests": {
      "type": "integer",
      "description": "Responses to this agent in the window, at any status."
    },
    "userAgent": {
      "type": "string",
      "maxLength": 512,
      "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."
    },
    "clientClass": {
      "type": "string",
      "description": "What the classifier made of this agent.",
      "knownValues": [
        "bot",
        "browser",
        "unknown"
      ]
    }
  },
  "description": "One user agent's share of the window."
}

Lexicon Garden

@