API

Feedback-Analyse abrufen

GET/api/crm/v2/feedback_analyticsv2
operationId: feedbackAnalytics.default

Gibt zusammenfassende Kacheln und ein Bewertungsdiagramm für den Zeitraum zurück. Jeder Punkt entspricht einer Stunde in UTC; es werden nur nicht-leere Punkte zurückgegeben. Die Benutzeroberfläche wandelt die Zeit automatisch in die Zeitzone des Nutzers um und fasst Stunden zu Tagen zusammen. Der Standardzeitraum ist heute. Der Zeitraum ist auf ein Jahr begrenzt; längere Zeiträume werden am Ende auf das letzte Jahr gekürzt. Die Anteil-Kachel enthält dynamics — die Veränderung im Vergleich zu date_comparison_*. Ist dieser Zeitraum nicht angegeben, wird standardmäßig der unmittelbar vor dem gewählten Zeitraum liegende Zeitraum gleicher Länge verwendet. Dieser Standardwert gilt nur für den Vergleich und wird nicht in den Filtern zurückgegeben.

Autorisierung

api-token + language + role

Abfrageparameter

date_fromstring

Beispiel: 25/04/2024

date_tostring

Beispiel: 26/04/2024

date_comparison_fromstring

Beispiel: 25/03/2024

date_comparison_tostring

Beispiel: 26/03/2024

chain_idinteger

Beispiel: 1

branch_idinteger

Beispiel: 1

Antworten

OK

object
statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringkann null sein

Beispiel: 2026-08-01 00:00:00

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_toobject (FilterDateTo)
valuestringkann null sein

Beispiel: 2026-08-31 23:59:59

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_rangeobject (FilterDateRange)

Vordefinierte Datumsfilterzeiträume; die Untergrenze wird in der Zeitzone des Benutzers berechnet. value — der Zeitraum, dem die aktuellen *_from und *_to entsprechen; null — benutzerdefinierter Zeitraum. default — der Zeitraum, den der Server bei Anfragen ohne Datumsangaben verwendet: Er wird auch beim ersten Laden des Bereichs angewendet und bei Zurücksetzen wiederhergestellt. Das obere Ende des Zeitraums entspricht immer dem aktuellen Tag des Benutzers, daher enthält option dieses nicht: Für vordefinierte Zeiträume muss *_to nicht übergeben werden, der Server setzt es automatisch. Zeiträume, die länger als ein Jahr sind, werden an der aktuellen Grenze abgeschnitten.

valuestring (DateRange) kann null sein

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

defaultstring (DateRange) erforderlich

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

typestringerforderlich

Beispiel: select

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

optionarray of objecterforderlich
valuestring (DateRange) erforderlich

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

date_fromstringerforderlich

Beispiel: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringkann null sein

Beispiel: 2026-08-01 00:00:00

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_comparison_toobject (FilterDateTo)
valuestringkann null sein

Beispiel: 2026-08-31 23:59:59

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Vorgefertigte Datumsbereichsfilter ohne Standardwert: default ist immer null.

valuestring (DateRange) kann null sein

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

defaultstring (DateRange) kann null sein

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

typestringerforderlich

Beispiel: select

optionarray of objecterforderlich
valuestring (DateRange) erforderlich

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

date_fromstringerforderlich

Beispiel: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

tilesobject
totalobject (FeedbackAnalyticsCountTile) erforderlich

Zähler-Kachel in der Zusammenfassungszeile: Anzahl der Bewertungen und deren Anteil im Zeitraum. percent ist null, wenn es im Zeitraum keine Bewertungen gibt. Die Veränderung im Vergleichszeitraum wird absichtlich nicht übermittelt: Die Anzahl der Bewertungen hängt vom Traffic ab, daher sagt ihr Anstieg nichts über die Qualität aus.

valueintegererforderlich

Beispiel: 96

percentnumber · float

Beispiel: 75

positiveobject (FeedbackAnalyticsCountTile) erforderlich

Zähler-Kachel in der Zusammenfassungszeile: Anzahl der Bewertungen und deren Anteil im Zeitraum. percent ist null, wenn es im Zeitraum keine Bewertungen gibt. Die Veränderung im Vergleichszeitraum wird absichtlich nicht übermittelt: Die Anzahl der Bewertungen hängt vom Traffic ab, daher sagt ihr Anstieg nichts über die Qualität aus.

valueintegererforderlich

Beispiel: 96

percentnumber · float

Beispiel: 75

negativeobject (FeedbackAnalyticsCountTile) erforderlich

Zähler-Kachel in der Zusammenfassungszeile: Anzahl der Bewertungen und deren Anteil im Zeitraum. percent ist null, wenn es im Zeitraum keine Bewertungen gibt. Die Veränderung im Vergleichszeitraum wird absichtlich nicht übermittelt: Die Anzahl der Bewertungen hängt vom Traffic ab, daher sagt ihr Anstieg nichts über die Qualität aus.

valueintegererforderlich

Beispiel: 96

percentnumber · float

Beispiel: 75

positive_shareobject (FeedbackAnalyticsShareTile) erforderlich

Kachel des Anteils in der Zusammenfassungszeile. Im Gegensatz zu Zählern enthält sie dynamics – die Veränderung des Anteils im Vergleichszeitraum in Prozentpunkten; sie ist unabhängig vom Traffic. percent und dynamics sind null, wenn keine Berechnungsgrundlage vorhanden ist: Es gibt keine Bewertungen für den Zeitraum oder den Vergleichszeitraum.

valueintegererforderlich

Beispiel: 96

percentnumber · float

Beispiel: 75

dynamicsnumber · float

Beispiel: -0.2

pointsarray of object
datetimestringerforderlich

Beginn des Stundenintervalls in UTC

Beispiel: 2026-09-08 10:00:00

positiveintegererforderlich

Beispiel: 3

negativeintegererforderlich

Beispiel: 1