Feedback Analytics API

Intro

Eine REST-API für alles: Workspaces und Formulare abrufen (inkl. Schema und Analytics), Formularantworten abrufen (mit Antworten, Bewertung, Datentabellen-Verknüpfung), Datentabellen verwalten (CRUD auf Zeilen), E-Mail-Verlauf und Events. API-Key-Authentifizierung. Geeignet für Zapier, Make, n8n und eigene Apps.

Quick start

curl https://feedback-analytics.com/api/v1/workspaces \
  -H "X-API-Key: YOUR_API_KEY"

{
  "data": [
    {
      "id": "ws_123",
      "name": "Main workspace",
      "link": "my-workspace"
    }
  ],
  "meta": {},
  "links": {},
  "request_id": "req_abc123"
}

Authentifizierung

Sende bei jeder Anfrage den Header X-API-Key mit deinem API-Schlüssel. Schlüssel beginnen mit fa_. Dein API-Schlüssel hat Zugriff auf einen oder mehrere Workspaces; du darfst nur Ressourcen dieser Workspaces abfragen.

API-Schlüssel anlegen unter Workspace-Einstellungen → API-Schlüssel (nach Anmeldung). Schlüssel sicher aufbewahren und nie in Frontend-Code oder öffentlichen Repos teilen.

curl "https://feedback-analytics.com/api/v1/workspaces" \
  -H "X-API-Key: fa_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response format

Elke succes-response heeft exact vier top-level velden. Errors hebben error en request_id.

{
  "data": {},
  "meta": {},
  "links": {},
  "request_id": "req_abc123"
}

Fehlercodes

Bei einem Fehler liefert die API JSON mit error, message und optional details.

{
  "error": {
    "code": "resource_not_found",
    "message": "Resource not found",
    "status": 404
  },
  "request_id": "req_abc123"
}

Error codes

Pagination

Cursor-based: gebruik limit (standaard 20, max 100) en cursor voor de volgende pagina. Gebruik links.next voor de volgende URL.

curl "https://feedback-analytics.com/api/v1/workspaces/WORKSPACE_ID/responses?limit=20&cursor=resp_123" \
  -H "X-API-Key: YOUR_API_KEY"

• • default limit = 20, max limit = 100
• • cursor-based; geen page/offset
• • meta.has_more geeft aan of er meer pagina's zijn

Filtering & sort

Query parameters per resource. Veelvoorkomend: form_id, created_after, created_before, score_gte, score_lte. Sort: sort=veld:richting (asc of desc).

curl "https://feedback-analytics.com/api/v1/workspaces/WORKSPACE_ID/responses?form_id=form_123&limit=20" \
  -H "X-API-Key: YOUR_API_KEY"

curl "https://feedback-analytics.com/api/v1/workspaces/WORKSPACE_ID/responses?created_after=2026-01-01&score_gte=8" \
  -H "X-API-Key: YOUR_API_KEY"

curl "https://feedback-analytics.com/api/v1/workspaces/WORKSPACE_ID/responses?sort=created_at:desc" \
  -H "X-API-Key: YOUR_API_KEY"

Resources

Alle endpoints zijn genest onder /api/v1/workspaces/{workspace_id}. Vervang workspace_id met de id uit GET /workspaces.

Workspaces

Workspaces die de API-key kan benaderen. Gebruik de id als workspace_id in alle andere endpoints.

curl "https://feedback-analytics.com/api/v1/workspaces" -H "X-API-Key: YOUR_API_KEY"

Forms

Du kannst Formulare in einem Workspace abrufen (Liste und Details), das Formularschema (Fragen, Typen, Optionen, Validierung; nützlich für Integrationen) und eine Analytics-Zusammenfassung (Gesamt-Responses, Durchschnittsbewertung, letzte Response). Der Schema-Endpoint unterstützt If-None-Match / ETag für Caching. Siehe Übersicht unten und die OpenAPI-Spezifikation für alle Parameter.

Questions

Vragen horen bij een formulier. Alleen lezen in v1.

Responses

Formularantworten abrufen: Liste mit Paginierung, Filter und Sortierung oder eine Response per ID. Jede Response enthält Antworten, Bewertung, Verknüpfung zu Formular und Datentabelle (row_id). Bei Ausfüllen über E-Mail-Link erhältst du respondent_email und email_id. Mit include_table_data=true die Datentabellen-Zeile zum Zeitpunkt des Absendens. Ideal für Berichte, CRM-Sync oder eigene Dashboards.

Veelgebruikte filters

form_id, created_after, created_before, score_gte, score_lte

curl "https://feedback-analytics.com/api/v1/workspaces/WORKSPACE_ID/responses?form_id=form_123&limit=20" \
  -H "X-API-Key: YOUR_API_KEY"

{
  "data": [
    {
      "id": "resp_123",
      "form_id": "form_123",
      "score": 8,
      "created_at": "2026-03-10T12:00:00Z",
      "answers": [],
      "respondent_email": null,
      "row_id": null
    }
  ],
  "meta": { "limit": 20, "has_more": false },
  "links": { "self": "...", "next": null, "prev": null },
  "request_id": "req_abc123"
}

Datatables

Zeilen in Datentabellen verwalten: Tabellen auflisten, Felder abrufen, Zeilen mit Filter und Sortierung lesen, eine oder mehrere Zeilen hinzufügen/aktualisieren (Upsert auf data.id) oder löschen.

Rows (datatable-rijen)

CRUD op rijen binnen een datatable. Server wijst row_id toe bij POST. PATCH voor partiële update, DELETE voor verwijderen.

curl -X POST "https://feedback-analytics.com/api/v1/workspaces/WORKSPACE_ID/datatables/DATATABLE_ID/rows" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": {"email": "jan@voorbeeld.nl", "naam": "Jan"}}'

{
  "data": {
    "row_id": "row_abc",
    "email": "jan@voorbeeld.nl",
    "naam": "Jan",
    "created_at": "2026-03-10T12:00:00Z",
    "updated_at": "2026-03-10T12:00:00Z"
  },
  "meta": {},
  "links": {},
  "request_id": "req_abc123"
}

Email events

E-Mail-Event-Verlauf abrufen: Sendungen, Opens, Clicks, Bounces usw., verknüpft mit email_id, row_id, form_id und flow_id. Nützlich für Berichte oder CRM-Sync.

Filters: email_id, type, created_after, created_before, recipient

curl "https://feedback-analytics.com/api/v1/workspaces/WORKSPACE_ID/email-events?limit=20&sort=created_at:desc" \
  -H "X-API-Key: YOUR_API_KEY"

Webhook endpoints

Beheer webhook-URLs voor events. POST om aan te maken, DELETE om te verwijderen.

API keys

Lijst metadata van API-keys (geen secrets). POST om een key aan te maken; de secret wordt één keer getoond. DELETE om te revoken.

Rate limit

Pro API-Schlüssel gilt ein Rate Limit (ca. 60 Anfragen pro Minute). Die Response-Header X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset zeigen die aktuelle Nutzung.

Elke response bevat de headers X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (Unix seconden).

OpenAPI specification

De machine-readable OpenAPI 3.0-spec kun je gebruiken voor client generation, Postman/Insomnia import, tooling en SDK-generation.

Diese Dokumentation folgt der Implementierungsspezifikation docs/API-ARCHITECTURE-DESIGN.md. Endpoint-Matrix: docs/API-ENDPOINT-MATRIX.md. Gap-Analyse: docs/API-GAP-ANALYSIS.md. OpenAPI: GET /api/v1/openapi. Paginierung: cursor + limit (Standard 20, max 100).