api-reference

1. API-Schluessel erstellen

Gehen Sie zu Ihren Website-Einstellungen > API-Tab im Flowsery Analytics-Dashboard. Generieren Sie einen neuen API-Schluessel. Kopieren Sie ihn sofort, da er nicht erneut angezeigt wird. Behandeln Sie Ihre API-Schluessel wie Passwoerter -- speichern Sie sie sicher und geben Sie sie niemals in clientseitigem Code oder oeffentlichen Repositories preis. Alle Schluessel verwenden das Praefix <code>flow_</code> (z. B. <code>flow_sk_live_abc123</code>).

2. Anfragen authentifizieren

Jeder API-Aufruf muss den Authorization-Header unter Verwendung des Bearer-Schemas enthalten. API-Schlüssel müssen mit dem Präfix „flow_“ beginnen.

Authorization-Header
Authorization: Bearer YOUR_API_KEY

3. Anfragen stellen

Die Basis-URL fuer alle v1-Endpunkte lautet: <code>https://analytics.flowsery.com/api/v1/</code>

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> – Der Schlüssel API fehlt, ist ungültig oder beginnt nicht mit flow_.<br /><strong>404 Not Found</strong> – Die angeforderte Ressource ist nicht vorhanden.<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/api/v1/overview \
  --header 'Authorization: Bearer <api-key>'
200
{
  "status": "success",
  "data": [
    {
      "visitors": 12450,
      "sessions": 16890
    }
  ]
}