space.highport.manage.listSiteVisitors

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.

Details · query
Kindquery
Authoritymanage.highport.space
Indexed
cid bafyreigeammfqschkkvc74fxrdaowqle3oia7jhl7gj53qyggo7bxdzzmu

Checks

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