api-reference

1. API-Token oder Website-Schlüssel erstellen

Erstellen Sie ein Workspace-API-Token auf der Seite API Tokens, wenn Sie programmatischen Zugriff auf alle Websites im Workspace benötigen, einschließlich MCP- und OpenClaw-Integrationen. Workspace-Tokens verwenden das Präfix <code>flow_ws_</code>. Für Server-zu-Server-Tracking einer einzelnen Website erstellen Sie einen Website-API-Schlüssel unter Einstellungen > API dieser Website; Website-Schlüssel verwenden das Präfix <code>flow_</code>. Kopieren Sie neue Tokens sofort, da das Secret nur einmal angezeigt wird.

2. Anfragen authentifizieren

Jeder API-Aufruf muss den Authorization-Header mit dem Bearer-Schema enthalten. Verwenden Sie ein <code>flow_ws_</code>-Workspace-Token für API-Zugriff über mehrere Websites oder einen <code>flow_</code>-Website-Schlüssel für eine einzelne Website.

Authorization-Header
Authorization: Bearer YOUR_API_KEY

3. Anfragen stellen

Die Basis-URL für alle v1-Endpunkte lautet: <code>https://analytics.flowsery.com/api/v1/</code>. Rufen Sie mit einem Workspace-Token zuerst <code>GET /websites</code> auf und übergeben Sie danach <code>websiteId</code> oder <code>domain</code> an Endpunktanfragen. Website-Schlüssel sind bereits an eine Website gebunden und benötigen keinen Selector.

Antwortformat

Erfolgreiche Antworten geben den Status 200 OK mit einer wie folgt strukturierten Antwort zurueck:

Erfolgreiche Antwort
{
  "status": "success",
  "data": { ... }
}

Fehler verwenden die normale HTTP-Fehlerantwortform von NestJS.

Fehlerantwort
{
  "message": "Unauthorized",
  "statusCode": 401
}

Standard-Fehlercodes

<strong>400 Bad Request</strong> -- Die Eingabe ist ungültig oder erforderliche Parameter fehlen.<br /><strong>401 Unauthorized</strong> -- Das API-Token fehlt, ist ungültig, abgelaufen oder für diesen Endpunkt nicht zulässig.<br /><strong>404 Not Found</strong> -- Die angeforderte Ressource existiert nicht.<br /><strong>500 Internal Server Error</strong> -- Auf dem Server ist ein unerwartetes Problem aufgetreten.
Beispielanfrage (curl)
curl --request GET \
  --url https://analytics.flowsery.com/analytics/api/v1/websites \
  --header 'Authorization: Bearer <workspace-api-token>'
200
{
  "status": "success",
  "data": [
    {
      "id": "cm8abc123",
      "domain": "example.com",
      "timezone": "America/New_York",
      "currency": "USD",
      "trackingId": "flid_abc123"
    }
  ]
}