> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Website-Analytics

> Analytics für eine auf Square Cloud gehostete Website abrufen. Es gilt ein Rate-Limit von 10 nicht zwischengespeicherten Anfragen alle 60 Sekunden.

<ParamField header="Authorization" type="string" placeholder="API Key" required>
  Der API-Schlüssel für Ihr Konto. Sie finden ihn in Ihren [Kontoeinstellungen](https://squarecloud.app/de/account/security).
</ParamField>

### Parameter

<ParamField path="app_id" type="string" placeholder="Application ID" required>
  Die ID der Anwendung. Du findest sie in der URL des Dashboards deiner Anwendung.
</ParamField>

<ParamField query="start" type="string" placeholder="ISO 8601 timestamp" required>
  ISO-8601-Startzeitstempel für den Analysezeitraum. Der maximale Aufbewahrungszeitraum beträgt 7 Tage; der Startwert wird auf das Erstellungsdatum der Anwendung begrenzt.
</ParamField>

<ParamField query="end" type="string" placeholder="ISO 8601 timestamp" required>
  ISO-8601-Endzeitstempel. Muss nach `start` liegen.
</ParamField>

#### Drilldown-Filter

Optionale Filter, die **jede** Aufschlüsselung auf den passenden Traffic einschränken. Gib den exakten `type`-Wert zurück, der von der entsprechenden Aufschlüsselung in einer vorherigen Antwort geliefert wurde. Filter werden kombiniert (AND).

<ParamField query="country" type="string" placeholder="BR">
  Ein einzelnes Client-Land (2-stelliger Code), wie in der `countries`-Aufschlüsselung geliefert.
</ParamField>

<ParamField query="ip" type="string" placeholder="203.0.113.45">
  Eine einzelne Client-IP (exakter IPv4-/IPv6-Treffer), wie in der `ips`-Aufschlüsselung geliefert.
</ParamField>

<ParamField query="path" type="string" placeholder="/api">
  Anfragepfade, die mit diesem Präfix beginnen (z. B. deckt `/api` auch `/api/*` ab). Maximal 256 Zeichen.
</ParamField>

<ParamField query="status" type="string" placeholder="404">
  Ein einzelner Edge-Antwortstatuscode (3 Ziffern), wie in der `status_codes`-Aufschlüsselung geliefert.
</ParamField>

<ParamField query="os" type="string" placeholder="Windows">
  Ein einzelnes Client-Betriebssystem, wie in der `os`-Aufschlüsselung geliefert.
</ParamField>

<ParamField query="browser" type="string" placeholder="Chrome">
  Ein einzelner Client-Browser, wie in der `browsers`-Aufschlüsselung geliefert.
</ParamField>

<ParamField query="protocol" type="string" placeholder="HTTP/2">
  Ein einzelnes HTTP-Protokoll, wie in der `protocols`-Aufschlüsselung geliefert.
</ParamField>

<ParamField query="referer" type="string" placeholder="google.com">
  Ein einzelner Referer-Host, wie in der `referers`-Aufschlüsselung geliefert (`Direct` = kein Referer).
</ParamField>

<ParamField query="provider" type="string" placeholder="GOOGLE (15169)">
  Ein einzelnes Client-Netzwerk, wie in der `providers`-Aufschlüsselung geliefert — z. B. `GOOGLE (15169)`, eine reine ASN-Nummer oder `SQUARE-CLOUD-PLATFORM`.
</ParamField>

<ParamField query="content_type" type="string" placeholder="json">
  Ein einzelner Antwort-Content-Type, wie in der `content_types`-Aufschlüsselung geliefert (`Unknown` = nicht klassifiziert).
</ParamField>

<ParamField query="bot" type="string" placeholder="Search Engine Crawler">
  Eine einzelne Kategorie verifizierter Bots, wie in der `bots`-Aufschlüsselung geliefert (`Unverified` = regulärer Nicht-Bot-Traffic).
</ParamField>

### Antwort

<Info>
  Diese Route kann eine Antwort in komprimiertem Format senden und so die Datenübertragung optimieren.
</Info>

<ResponseField name="status" type="string">
  Gibt an, ob der Aufruf erfolgreich war. `success` bei Erfolg, `error` andernfalls.
</ResponseField>

<ResponseField name="response" type="object">
  Jede Aufschlüsselung ist ein Array von Buckets. `type` identifiziert die Dimension, `visits` sind eindeutige Besucher, `requests` ist die Anzahl der Anfragen, `bytes` sind die ausgelieferten Antwort-Bytes und `date` ist der Beginn des 15-Minuten-Fensters. Die Aufschlüsselungen `ips`, `status_codes`, `bots` und `content_types` sind Fenstersummen (Top-N über das gesamte Fenster) und enthalten **kein** `date`-Feld. Liefert ein leeres Objekt (`{}`), wenn das angeforderte Fenster vor dem Erstellungsdatum der Anwendung beginnt.
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "status": "success",
    "response": {
      "visits": [
        { "visits": 1024, "requests": 1247, "bytes": 8421000, "date": "2026-05-21T10:00:00Z" }
      ],
      "countries": [
        { "type": "BR", "visits": 612, "requests": 743, "bytes": 5012000, "date": "2026-05-21T10:00:00Z" }
      ],
      "devices": [
        { "type": "desktop", "visits": 820, "requests": 998, "bytes": 6700000, "date": "2026-05-21T10:00:00Z" }
      ],
      "os": [
        { "type": "Windows", "visits": 540, "requests": 651, "bytes": 4400000, "date": "2026-05-21T10:00:00Z" }
      ],
      "browsers": [
        { "type": "Chrome", "visits": 720, "requests": 870, "bytes": 5800000, "date": "2026-05-21T10:00:00Z" }
      ],
      "protocols": [
        { "type": "HTTP/2", "visits": 900, "requests": 1100, "bytes": 7400000, "date": "2026-05-21T10:00:00Z" }
      ],
      "methods": [
        { "type": "GET", "visits": 850, "requests": 1020, "bytes": 6900000, "date": "2026-05-21T10:00:00Z" }
      ],
      "paths": [
        { "type": "/", "visits": 410, "requests": 498, "bytes": 3320000, "date": "2026-05-21T10:00:00Z" }
      ],
      "referers": [
        { "type": "Direct", "visits": 380, "requests": 462, "bytes": 3100000, "date": "2026-05-21T10:00:00Z" }
      ],
      "providers": [
        { "type": "AS15169 (GOOGLE)", "visits": 210, "requests": 254, "bytes": 1700000, "date": "2026-05-21T10:00:00Z" }
      ],
      "ips": [
        { "type": "203.0.113.45", "visits": 40, "requests": 3120, "bytes": 2100000 }
      ],
      "status_codes": [
        { "type": "200", "visits": 950, "requests": 1180, "bytes": 8100000 }
      ],
      "bots": [
        { "type": "Search Engine Crawler", "visits": 0, "requests": 84, "bytes": 410000 }
      ],
      "content_types": [
        { "type": "json", "visits": 310, "requests": 720, "bytes": 4200000 }
      ]
    }
  }
  ```
</ResponseExample>