space.highport.manage.listSiteVisitors

lexicons.highport.space

Documentation

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.

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

Parameters

cursor string Optional

Pagination cursor from a previous response.

domain string Required

The registered hostname. Must belong to the caller.

from string datetime Optional

Inclusive lower bound. Defaults to 30 days ago.

limit integer Optional

Maximum entries to return.

to string datetime Optional

Exclusive upper bound. Defaults to now.

Output

Encodingapplication/json
cursor string Optional

Present when more entries exist.

visitors array Required

No description available.

Errors

InvalidDomain Not a valid, non-reserved, public-suffix-safe domain. Unlike DomainNotFound, the input is not a hostname at all.
DomainNotFound No such domain, or it does not belong to the caller.
AnalyticsDisabled This deployment has no analytics store configured.
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
Pagination cursor from a previous response.
The registered hostname. Must belong to the caller.
Inclusive lower bound. Defaults to 30 days ago.
Maximum entries to return.
Exclusive upper bound. Defaults to now.
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "InvalidDomain",
      "description": "Not a valid, non-reserved, public-suffix-safe domain. Unlike DomainNotFound, the input is not a hostname at all."
    },
    {
      "name": "DomainNotFound",
      "description": "No such domain, or it does not belong to the caller."
    },
    {
      "name": "AnalyticsDisabled",
      "description": "This deployment has no analytics store configured."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "visitors"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "description": "Present when more entries exist."
        },
        "visitors": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "did",
              "requests",
              "bytesBilled",
              "lastSeen"
            ],
            "properties": {
              "did": {
                "type": "string",
                "format": "did",
                "description": "The visitor's identity."
              },
              "lastSeen": {
                "type": "string",
                "format": "datetime",
                "description": "This visitor's most recent request to the domain."
              },
              "requests": {
                "type": "integer",
                "description": "Responses served to this visitor here."
              },
              "bytesBilled": {
                "type": "integer",
                "description": "Billed bytes."
              }
            },
            "description": "One signed-in visitor, and what they spent here."
          }
        }
      }
    },
    "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."
      },
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum entries to return."
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor from a previous response."
      },
      "domain": {
        "type": "string",
        "maxLength": 253,
        "description": "The registered hostname. Must belong to the caller."
      }
    }
  },
  "description": "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."
}

Lexicon Garden

@