REST-API

Auswertung

Kennzahlen, Zeitreihen, Aufschlüsselungen und häufige Fragen eines Assistenten abrufen, wie in der Auswertung im Portal.

Wofür

GET /analytics liefert dieselben Zahlen wie die Auswertung im Portal, damit du sie in eigene Berichte oder ein BI-Werkzeug übernehmen kannst. Abgefragt wird immer ein Assistent.

Parameter

Parameter	Pflicht	Standard	Werte
`botId`	ja	–	Kennung des Assistenten
`range`	nein	`last30d`	`today`, `yesterday`, `last7d`, `last14d`, `last30d`, `month`, `lastmonth`, `last3m`, `last6m`, `year`, `lastyear`, `all`, `custom`
`from` / `to`	bei `custom`	–	Datum als `YYYY-MM-DD`; Kalendertage in deutscher Zeit, beide einschließlich
`compare`	nein	`prev`	`none`, `prev` (gleich langer Zeitraum davor), `prevWeek`, `prevMonth`, `prevYear`

Beispiel

curlbash

curl "https://app.lymbe.ai/api/v1/analytics?botId=BOT_ID&range=custom&from=2026-09-01&to=2026-09-30&compare=prevMonth" \
  -H "x-api-key: lymbe_DEIN_SCHLUESSEL"

fetchjavascript

const params = new URLSearchParams({ botId: 'BOT_ID', range: 'last7d', compare: 'prev' });
const res = await fetch('https://app.lymbe.ai/api/v1/analytics?' + params, {
  headers: { 'x-api-key': process.env.LYMBE_API_KEY },
});
const report = await res.json();
console.log(report.kpis, report.hasAnyData);

Aufbau der Antwort

Feld	Inhalt
`bot`, `tenantSlug`	Welcher Assistent, welcher Workspace
`range`, `compare`, `granularity`	Der tatsächlich verwendete Zeitraum, Vergleich und die Auflösung der Zeitreihe
`kpis`	Die Kennzahlen mit Wert und Vergleichswert
`series`	Zeitreihe für die Diagramme
`breakdowns`	`pages`, `sources`, `devices`: je höchstens 8 Einträge
`questions`	`frequent` (5 häufigste Fragen), `unanswered` (5 unbeantwortete), `unansweredTotal`
`tracking`	Zustand der Messung auf deiner Website: `status`, `lastEventAt`, `badOriginHost`, `invalidBotId`
`hasAnyData`	`false`, solange für diesen Assistenten noch gar nichts gemessen wurde

Tracking-Zustand nutzentracking.badOriginHost zeigt, dass Ereignisse von einer Domain kamen, die nicht in den erlaubten Domains steht. tracking.invalidBotId deutet auf einen falsch kopierten Widget-Code hin. Siehe Einbindung.

Fehler

Status	Ursache
400	`botId query parameter required`
403	Tarif ohne API-Zugang
404	Assistent oder Workspace nicht gefunden

Hinweise

Der Endpunkt zählt nicht zur Grenze von 100 Anfragen pro Stunde. Frag trotzdem nicht öfter als nötig ab, etwa einmal am Tag für den Vortag.
Besucher, die Do-Not-Track oder Global Privacy Control senden, werden je nach Einstellung nicht gezählt (siehe Datenschutz in der Auswertung).
Für Excel, PDF oder CSV ohne Programmierung nimm den Export, für regelmäßige Mails die Berichte.

VorherigeAssistenten NächsteWebhooks