space.highport.manage.listSiteVisitors

{
  "id": "space.highport.manage.listSiteVisitors",
  "defs": {
    "main": {
      "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."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}