Synupv1
Schlüssel erstellen
v1Ressourcen/Reviews

Reviews

Die Kundenbewertungen eines Standorts lesen und beantworten.

Liefert Bewertungen für einen Standort. Sowohl locationId als auch clientId sind erforderlich.

Reviews auflisten

get/api/v1/reviews
reviews:read
Query-Parameter
locationIdstringerforderlich
Der abzurufende Standort.
clientIdstringerforderlich
Der Kunde des Standorts.
sitesstringoptional
Kommagetrennte Bewertungsplattformen (z. B. google,facebook).
ratingsstringoptional
Kommagetrennte Sternebewertungen (z. B. 1,2).
sentimentstringoptional
Kommagetrennte Stimmungen (positive, neutral, negative).
statusstring (responded | unreplied)optional
Nach Antwortstatus filtern: responded oder unreplied.
keywordstringoptional
Freitextsuche im Bewertungstext und Autor.
fromstringoptional
Fensterbeginn (ISO-Datum).
tostringoptional
Fensterende (ISO-Datum).
sortstring (newest | oldest | lowest | highest)optional
Sortierreihenfolge: newest, oldest, lowest oder highest.
deletedstring (1)optional
1 übergeben, um entfernte/nicht mehr vorhandene statt aktueller Bewertungen anzuzeigen.
cursorstringoptional
Paginierungs-Cursor aus dem nextCursor einer vorherigen Antwort.
limitintegeroptional
Bewertungen pro Seite, 1-100. Standard 30.
Antwort
dataobjectoptional
foundbooleanoptional
Ob der Standort gefunden und für diesen Schlüssel zugänglich war.
reviewsarray of objectoptional
Die Bewertungen selbst.
idstringoptional
Eindeutige Kennung der Bewertung.
authorstringoptional
Name des Rezensenten, oder null, falls von der Quelle nicht angegeben.
ratingnumberoptional
Sternebewertung, oder null.
bodystringoptional
Der Bewertungstext.
reviewDatestringoptional
Zeitpunkt der Veröffentlichung der Bewertung, als ISO-8601-Zeitstempel, oder null.
platformstringoptional
Quellplattform, z. B. google, facebook.
platformLabelstringoptional
Anzeigename der Quellplattform, oder null.
sentimentstringoptional
Erkannte Stimmung der Bewertung, oder null.
replyobjectoptional
Die Antwort des Unternehmens, falls vorhanden, sonst null.
authorstringoptional
bodystringoptional
datestringoptional
reviewUrlstringoptional
Link zur Bewertung auf der Quellplattform, oder null.
respondablebooleanoptional
Ob auf diese Bewertung noch geantwortet werden kann.
nextCursorstringoptional
Paginierungs-Cursor für die nächste Seite, oder null, wenn keine weiteren Ergebnisse vorliegen.
totalnumberoptional
Gesamtzahl der zur Anfrage passenden Bewertungen.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews
Ihr API-Schlüssel
locationId *
clientId *
sites
ratings
sentiment
status
keyword
from
to
sort
deleted
cursor
limit
{
  "data": {
    "found": true,
    "reviews": [
      {
        "id": "rev_1",
        "author": "Jane D.",
        "rating": 5,
        "body": "Great service!",
        "reviewDate": "2026-02-01T12:00:00.000Z",
        "platform": "google",
        "platformLabel": "Google",
        "sentiment": "positive",
        "reply": null,
        "reviewUrl": "https://google.com/...",
        "respondable": true
      }
    ],
    "nextCursor": null,
    "total": 1
  }
}
v1Ressourcen/Reviews/getBewertungszusammenfassung abrufen

Liefert eine zusammengefasste Bewertungsübersicht für Ihre gesamte Agentur (oder einen Kunden) — Bewertungsverteilung, Volumen und Trend über den ausgewählten Zeitraum.

Bewertungszusammenfassung abrufen

get/api/v1/reviews/summary
reviews:read
Query-Parameter
clientIdstringoptional
Auf die Bewertungen eines Kunden beschränken. Weggelassen, werden alle Bewertungen zusammengefasst, die Ihr Schlüssel sehen kann.
tagsstringoptional
Auf Standorte mit einem dieser durch Komma getrennten internen Tags beschränken.
fromstringoptional
Beginn des Zeitraums (einschließlich), als JJJJ-MM-TT. Standardmäßig ein rollierendes Zeitfenster der letzten Zeit.
tostringoptional
Ende des Zeitraums (einschließlich), als JJJJ-MM-TT. Standardmäßig heute.
Antwort
dataobjectoptional
Die zusammengefasste Übersicht — Bewertungsverteilung, Bewertungsvolumen und Trenddaten für den ausgewählten Zeitraum.
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/summary
Ihr API-Schlüssel
clientId
tags
from
to
{}
v1Ressourcen/Reviews/getBewertungsquellen auflisten

Jede Bewertungsquelle für einen Standort — verbundene Plattformen (Google, Facebook, ...) sowie benutzerdefinierte URLs (Yelp, TripAdvisor, ...), mit Status und Ausblendstatus.

Bewertungsquellen auflisten

get/api/v1/reviews/sources
reviews:read
Query-Parameter
locationIdstringerforderlich
Der abzufragende Standort.
clientIdstringerforderlich
Der Kunde des Standorts.
Antwort
dataobjectoptional
sourcesarray of objectoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/sources
Ihr API-Schlüssel
locationId *
clientId *
{}
v1Ressourcen/Reviews/postBenutzerdefinierte Bewertungsquelle hinzufügen

Fügt eine benutzerdefinierte Bewertungsseiten-URL (Yelp, TripAdvisor, Trustpilot oder jede Unternehmensbewertungsseite) als Quelle für diesen Standort hinzu. Die Plattform wird automatisch aus der URL erkannt. Validiert die URL vor dem Hinzufügen nicht live — eine fehlerhafte URL zeigt sich erst später als fehlgeschlagener Scrape.

Benutzerdefinierte Bewertungsquelle hinzufügen

post/api/v1/reviews/sources
reviews:write
Anfragetext
locationIdstringerforderlich
clientIdstringerforderlich
urlstringerforderlich
Die hinzuzufügende Bewertungsseiten-URL.
Antwort
dataobjectoptional
idstringoptional
Die ID der neu erstellten benutzerdefinierten Quelle.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
409Diese URL ist bereits eine Quelle für diesen Standort.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/reviews/sources
Ihr API-Schlüssel
Anfragetext*
{}
v1Ressourcen/Reviews/patchBewertungsquelle aktualisieren

Eine Quelle (automatische Plattform oder benutzerdefiniert) aus- oder einblenden, oder das Abruf-Intervall einer benutzerdefinierten Quelle ändern.

Bewertungsquelle aktualisieren

patch/api/v1/reviews/sources/{id}
reviews:write
Query-Parameter
idstringerforderlich
Der Schlüssel der Quelle — ein automatischer Plattform-Slug (z. B. "google") oder eine benutzerdefinierte Quellen-ID.
Anfragetext
typestring (auto | custom)erforderlich
locationIdstringerforderlich
clientIdstringerforderlich
hidebooleanoptional
true setzen, um diese Quelle aus der Bewertungsansicht auszublenden, false zum Einblenden.
fetchIntervalHoursintegeroptional
Neues Scrape-Intervall in Stunden. Nur für benutzerdefinierte Quellen.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
422Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
patch/api/v1/reviews/sources/{id}
Ihr API-Schlüssel
id *
Anfragetext*
{}
v1Ressourcen/Reviews/deleteBenutzerdefinierte Bewertungsquelle entfernen

Entfernt eine benutzerdefinierte Bewertungsquelle dauerhaft und beendet deren Abruf.

Benutzerdefinierte Bewertungsquelle entfernen

delete/api/v1/reviews/sources/{id}
reviews:write
Query-Parameter
idstringerforderlich
locationIdstringerforderlich
clientIdstringerforderlich
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
delete/api/v1/reviews/sources/{id}
Ihr API-Schlüssel
id *
locationId *
clientId *
{}
v1Ressourcen/Reviews/postBlockierte/fehlgeschlagene Bewertungsquelle erneut versuchen

Setzt den Fehlerstatus einer benutzerdefinierten Quelle zurück und reiht sie für einen sofortigen Scrape wieder ein.

Blockierte/fehlgeschlagene Bewertungsquelle erneut versuchen

post/api/v1/reviews/sources/{id}/retry
reviews:write
Query-Parameter
idstringerforderlich
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/reviews/sources/{id}/retry
Ihr API-Schlüssel
id *
{}
v1Ressourcen/Reviews/getBewertungsanalysen abrufen

KPIs (mit Perioden-über-Perioden-Deltas), ein monatlicher Trend (Volumen, Bewertung, Stimmungsmix, Antwortquote), Bewertungsverteilung, Aufschlüsselung je Plattform, Timing nach Wochentag, ein Agentur-Benchmark, Themen und eine KI-Zusammenfassung — für einen Standort.

Bewertungsanalysen abrufen

get/api/v1/reviews/analytics
reviews:read
Query-Parameter
locationIdstringerforderlich
Der abzufragende Standort.
clientIdstringerforderlich
Der Kunde des Standorts.
kpiDaysinteger (7 | 30 | 90)optional
KPI-Zeitfenster in Tagen: 7, 30 oder 90. Standard 30.
trendMonthsinteger (3 | 6 | 12)optional
Trend-Länge in Monaten: 3, 6 oder 12. Standard 6.
Antwort
dataobjectoptional
Die vollständigen Bewertungsanalyse-Daten.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/analytics
Ihr API-Schlüssel
locationId *
clientId *
kpiDays
trendMonths
{}
v1Ressourcen/Reviews/getZusammenfassung der Bewertungsanalysen abrufen

Über die Standorte dieses Kunden (oder der gesamten Agentur) aggregierte Bewertungsanalysen: Anzahl, Durchschnittsbewertung, Bewertungsverteilung, Stimmungsmix, Antwortquote, Aufschlüsselung je Plattform und ein monatlicher Trend. Mit tags auf eine Teilmenge eingrenzen.

Zusammenfassung der Bewertungsanalysen abrufen

get/api/v1/reviews/analytics/summary
reviews:read
Query-Parameter
clientIdstringoptional
Auf die Standorte eines Kunden beschränken.
tagsstringoptional
Kommagetrennte Standort-Tag-Namen — nur Standorte mit mindestens einem davon werden berücksichtigt.
monthsintegeroptional
Trend-Länge in Monaten. Standard 6.
Antwort
dataobjectoptional
locationsnumberoptional
Anzahl der Standorte im Geltungsbereich.
countnumberoptional
Gesamtzahl der Bewertungen im Geltungsbereich.
avgRatingnumberoptional
Durchschnittsbewertung über den Geltungsbereich.
distributionobjectoptional
Anzahl der Bewertungen je Sternebewertung (1-5).
sentimentobjectoptional
Anzahl der Bewertungen je Stimmung.
positivenumberoptional
neutralnumberoptional
negativenumberoptional
responseRatenumberoptional
Prozentsatz der Bewertungen mit einer Antwort.
byPlatformarray of objectoptional
Anzahl und Durchschnittsbewertung je Plattform.
platformstringoptional
countnumberoptional
avgRatingnumberoptional
trendarray of objectoptional
Monatliche Anzahl und Durchschnittsbewertung.
monthstringoptional
countnumberoptional
avgRatingnumberoptional
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/analytics/summary
Ihr API-Schlüssel
clientId
tags
months
{}
v1Ressourcen/Reviews/getVerfolgte Wettbewerber auflisten

Die für einen Standort verfolgten Wettbewerber.

Verfolgte Wettbewerber auflisten

get/api/v1/reviews/competitors
reviews:read
Query-Parameter
locationIdstringoptional
apiDocs.resources.reviews.competitors.get.paramsLocationId
clientIdstringoptional
apiDocs.resources.reviews.competitors.get.paramsClientId
Antwort
dataobjectoptional
competitorsarray of objectoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/competitors
Ihr API-Schlüssel
locationId
clientId
{}
v1Ressourcen/Reviews/postWettbewerber hinzufügen

Beginnt, einen Wettbewerber anhand des Namens für einen Standort zu verfolgen.

Wettbewerber hinzufügen

post/api/v1/reviews/competitors
reviews:write
Anfragetext
locationIdstringoptional
apiDocs.resources.reviews.competitors.post.paramsLocationId
clientIdstringoptional
apiDocs.resources.reviews.competitors.post.paramsClientId
namestringerforderlich
Der Firmenname des Wettbewerbers.
Antwort
dataobjectoptional
competitorobjectoptional
Profilzeile eines Wettbewerbers (ID, Name, Quelle, angeheftet usw.).
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/reviews/competitors
Ihr API-Schlüssel
Anfragetext*
{}
v1Ressourcen/Reviews/getWettbewerbsanalyse der Bewertungen abrufen

Vergleicht die Bewertungen eines Standorts mit seinen verfolgten Wettbewerbern: Scorecard, Stärken/Lücken sowie Bewertungsgeschwindigkeit + Share of Voice.

Wettbewerbsanalyse der Bewertungen abrufen

get/api/v1/reviews/competitors/analysis
reviews:read
Query-Parameter
locationIdstringerforderlich
clientIdstringerforderlich
Antwort
dataobjectoptional
Die vollständigen Wettbewerbsanalyse-Daten (Scorecard, Stärken/Lücken, Geschwindigkeit).
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/competitors/analysis
Ihr API-Schlüssel
locationId *
clientId *
{}
v1Ressourcen/Reviews/deleteVerfolgten Wettbewerber entfernen

Beendet die Verfolgung eines Wettbewerbers anhand der ID dauerhaft.

Verfolgten Wettbewerber entfernen

delete/api/v1/reviews/competitors/{id}
reviews:write
Query-Parameter
idstringerforderlich
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
delete/api/v1/reviews/competitors/{id}
Ihr API-Schlüssel
id *
{}
v1Ressourcen/Reviews/postBewertungen eines Wettbewerbers aktualisieren

Ruft die Google-Bewertungen eines verfolgten Wettbewerbers erneut ab.

Bewertungen eines Wettbewerbers aktualisieren

post/api/v1/reviews/competitors/{id}/refresh
reviews:write
Query-Parameter
idstringerforderlich
Antwort
dataobjectoptional
okbooleanoptional
notestringoptional
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/reviews/competitors/{id}/refresh
Ihr API-Schlüssel
id *
{}
v1Ressourcen/Reviews/postapiDocs.resources.reviews.competitorsRefresh.summary

apiDocs.resources.reviews.competitorsRefresh.description

apiDocs.resources.reviews.competitorsRefresh.summary

post/api/v1/reviews/competitors/refresh
reviews:write
Anfragetext
clientIdstringerforderlich
apiDocs.resources.reviews.competitorsRefresh.paramsClientId
Antwort
dataobjectoptional
okbooleanoptional
queuedbooleanoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/reviews/competitors/refresh
Ihr API-Schlüssel
Anfragetext*
{}
v1Ressourcen/Reviews/getapiDocs.resources.reviews.notes.get.summary

apiDocs.resources.reviews.notes.get.description

apiDocs.resources.reviews.notes.get.summary

get/api/v1/reviews/notes
reviews:read
Query-Parameter
reviewIdstringerforderlich
apiDocs.resources.reviews.notes.get.paramsReviewId
Antwort
dataobjectoptional
notesarray of objectoptional
idstringoptional
apiDocs.resources.reviews.notes.fields.id
bodystringoptional
apiDocs.resources.reviews.notes.fields.body
authorUserIdstringoptional
apiDocs.resources.reviews.notes.fields.authorUserId
authorNamestringoptional
apiDocs.resources.reviews.notes.fields.authorName
createdAtstringoptional
apiDocs.resources.reviews.notes.fields.createdAt
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/notes
Ihr API-Schlüssel
reviewId *
{}
v1Ressourcen/Reviews/postapiDocs.resources.reviews.notes.post.summary

apiDocs.resources.reviews.notes.post.description

apiDocs.resources.reviews.notes.post.summary

post/api/v1/reviews/notes
reviews:write
Anfragetext
reviewIdstringerforderlich
apiDocs.resources.reviews.notes.post.paramsReviewId
bodystringerforderlich
apiDocs.resources.reviews.notes.post.paramsBody
Antwort
dataobjectoptional
idstringoptional
apiDocs.resources.reviews.notes.fields.id
bodystringoptional
apiDocs.resources.reviews.notes.fields.body
authorUserIdstringoptional
apiDocs.resources.reviews.notes.fields.authorUserId
authorNamestringoptional
apiDocs.resources.reviews.notes.fields.authorName
createdAtstringoptional
apiDocs.resources.reviews.notes.fields.createdAt
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/reviews/notes
Ihr API-Schlüssel
Anfragetext*
{}
v1Ressourcen/Reviews/deleteapiDocs.resources.reviews.notes.delete.summary

apiDocs.resources.reviews.notes.delete.description

apiDocs.resources.reviews.notes.delete.summary

delete/api/v1/reviews/notes
reviews:write
Query-Parameter
reviewIdstringerforderlich
apiDocs.resources.reviews.notes.delete.paramsReviewId
noteIdstringerforderlich
apiDocs.resources.reviews.notes.delete.paramsNoteId
Antwort
dataobjectoptional
deletedbooleanoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
delete/api/v1/reviews/notes
Ihr API-Schlüssel
reviewId *
noteId *
{}
v1Ressourcen/Reviews/postapiDocs.resources.reviews.topicKeywords.post.summary

apiDocs.resources.reviews.topicKeywords.post.description

apiDocs.resources.reviews.topicKeywords.post.summary

post/api/v1/reviews/topic-trends/keywords
reviews:write
Anfragetext
locationIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringerforderlich
apiDocs.resources.reviews.topicKeywords.paramsKeyword
Antwort
dataobjectoptional
customarray of stringoptional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
queuedbooleanoptional
notestringoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/reviews/topic-trends/keywords
Ihr API-Schlüssel
Anfragetext*
{}
v1Ressourcen/Reviews/deleteapiDocs.resources.reviews.topicKeywords.delete.summary

apiDocs.resources.reviews.topicKeywords.delete.description

apiDocs.resources.reviews.topicKeywords.delete.summary

delete/api/v1/reviews/topic-trends/keywords
reviews:write
Query-Parameter
locationIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringerforderlich
apiDocs.resources.reviews.topicKeywords.paramsKeyword
Antwort
dataobjectoptional
customarray of stringoptional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
delete/api/v1/reviews/topic-trends/keywords
Ihr API-Schlüssel
locationId
clientId
keyword *
{}
v1Ressourcen/Reviews/patchapiDocs.resources.reviews.topicKeywords.patch.summary

apiDocs.resources.reviews.topicKeywords.patch.description

apiDocs.resources.reviews.topicKeywords.patch.summary

patch/api/v1/reviews/topic-trends/keywords
reviews:write
Anfragetext
locationIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringoptional
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringerforderlich
apiDocs.resources.reviews.topicKeywords.paramsKeyword
hidebooleanerforderlich
apiDocs.resources.reviews.topicKeywords.paramsHide
Antwort
dataobjectoptional
customarray of stringoptional
apiDocs.resources.reviews.topicKeywords.fieldsCustom
hiddenarray of stringoptional
apiDocs.resources.reviews.topicKeywords.fieldsHidden
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
patch/api/v1/reviews/topic-trends/keywords
Ihr API-Schlüssel
Anfragetext*
{}
v1Ressourcen/Reviews/getThemen-Trends abrufen

Eine gebündelte Zeitreihe je Bewertungsthema, eine Bestenliste, steigende/fallende Bewegungen sowie aufkommende/verblassende Themen — für einen Standort.

Themen-Trends abrufen

get/api/v1/reviews/topic-trends
reviews:read
Query-Parameter
locationIdstringerforderlich
clientIdstringerforderlich
windowDaysinteger (30 | 90 | 180)optional
Trend-Zeitfenster in Tagen: 30, 90 oder 180. Standard 90.
Antwort
dataobjectoptional
Die vollständigen Themen-Trends-Daten.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/topic-trends
Ihr API-Schlüssel
locationId *
clientId *
windowDays
{}
v1Ressourcen/Reviews/getLängere Monatsreihe eines Themas abrufen

Eine längere Monat-für-Monat-Reihe für Themen, über das Standard-Trendfenster hinaus.

Längere Monatsreihe eines Themas abrufen

get/api/v1/reviews/topic-trends/series
reviews:read
Query-Parameter
locationIdstringerforderlich
clientIdstringerforderlich
monthsintegeroptional
Reihenlänge in Monaten. Standard 12.
Antwort
dataobjectoptional
Die vollständigen Themen-Monatsreihen-Daten.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/topic-trends/series
Ihr API-Schlüssel
locationId *
clientId *
months
{}
v1Ressourcen/Reviews/getBewertungen mit Erwähnung eines Themas abrufen

Detailansicht der Bewertungen, die ein Thema erwähnen, optional auf einen Monat eingegrenzt.

Bewertungen mit Erwähnung eines Themas abrufen

get/api/v1/reviews/topic-trends/reviews
reviews:read
Query-Parameter
locationIdstringerforderlich
clientIdstringerforderlich
topicstringerforderlich
Das abzufragende Thema (aus GET /api/v1/reviews/topic-trends).
monthstringoptional
Auf eine Heatmap-Zelle eingrenzen (JJJJ-MM). Weglassen für die vollständige Historie.
limitintegeroptional
Maximale Anzahl zurückzugebender Bewertungen.
Antwort
dataobjectoptional
reviewsarray of objectoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/topic-trends/reviews
Ihr API-Schlüssel
locationId *
clientId *
topic *
month
limit
{}
v1Ressourcen/Reviews/getBewertungs-Widgets auflisten

Jedes für einen Standort konfigurierte Bewertungs-Widget.

Bewertungs-Widgets auflisten

get/api/v1/reviews/widgets
reviews:read
Query-Parameter
locationIdstringerforderlich
clientIdstringerforderlich
Antwort
dataobjectoptional
widgetsarray of objectoptional
idstringoptional
agencyIdstringoptional
locationIdstringoptional
clientLocationIdstringoptional
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstringoptional
manualReviewIdsarray of stringoptional
countintegeroptional
includeInternalbooleanoptional
emojiPositiveRatingintegeroptional
layoutstringoptional
marqueeSpeedintegeroptional
themeobjectoptional
themeOverridesobjectoptional
showFlagsobjectoptional
statusstring (draft | published)optional
createdAtstringoptional
updatedAtstringoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/widgets
Ihr API-Schlüssel
locationId *
clientId *
{}
v1Ressourcen/Reviews/postBewertungs-Widget erstellen

Erstellt ein neues einbettbares Bewertungs-Widget (Bewertungs-Badge + Bewertungskarussell/-liste) für einen Standort.

Bewertungs-Widget erstellen

post/api/v1/reviews/widgets
reviews:write
Anfragetext
locationIdstringerforderlich
clientIdstringerforderlich
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstring (30d | 90d | 1y | all)optional
countintegeroptional
includeInternalbooleanoptional
layoutstringoptional
statusstring (draft | published)optional
Antwort
dataobjectoptional
widgetobjectoptional
idstringoptional
agencyIdstringoptional
locationIdstringoptional
clientLocationIdstringoptional
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstringoptional
manualReviewIdsarray of stringoptional
countintegeroptional
includeInternalbooleanoptional
emojiPositiveRatingintegeroptional
layoutstringoptional
marqueeSpeedintegeroptional
themeobjectoptional
themeOverridesobjectoptional
showFlagsobjectoptional
statusstring (draft | published)optional
createdAtstringoptional
updatedAtstringoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/reviews/widgets
Ihr API-Schlüssel
Anfragetext*
{}
v1Ressourcen/Reviews/getBewertungs-Widget abrufen

Gibt die vollständige Konfiguration eines Bewertungs-Widgets zurück.

Bewertungs-Widget abrufen

get/api/v1/reviews/widgets/{id}
reviews:read
Query-Parameter
idstringerforderlich
Antwort
dataobjectoptional
widgetobjectoptional
idstringoptional
agencyIdstringoptional
locationIdstringoptional
clientLocationIdstringoptional
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstringoptional
manualReviewIdsarray of stringoptional
countintegeroptional
includeInternalbooleanoptional
emojiPositiveRatingintegeroptional
layoutstringoptional
marqueeSpeedintegeroptional
themeobjectoptional
themeOverridesobjectoptional
showFlagsobjectoptional
statusstring (draft | published)optional
createdAtstringoptional
updatedAtstringoptional
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/reviews/widgets/{id}
Ihr API-Schlüssel
id *
{}
v1Ressourcen/Reviews/patchBewertungs-Widget aktualisieren

Aktualisiert die Konfiguration oder das Design eines Widgets (oder veröffentlicht es über status).

Bewertungs-Widget aktualisieren

patch/api/v1/reviews/widgets/{id}
reviews:write
Query-Parameter
idstringerforderlich
Anfragetext
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstringoptional
manualReviewIdsarray of stringoptional
countintegeroptional
includeInternalbooleanoptional
emojiPositiveRatingintegeroptional
layoutstringoptional
marqueeSpeedintegeroptional
themeobjectoptional
themeOverridesobjectoptional
showFlagsobjectoptional
statusstring (draft | published)optional
Antwort
dataobjectoptional
widgetobjectoptional
idstringoptional
agencyIdstringoptional
locationIdstringoptional
clientLocationIdstringoptional
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstringoptional
manualReviewIdsarray of stringoptional
countintegeroptional
includeInternalbooleanoptional
emojiPositiveRatingintegeroptional
layoutstringoptional
marqueeSpeedintegeroptional
themeobjectoptional
themeOverridesobjectoptional
showFlagsobjectoptional
statusstring (draft | published)optional
createdAtstringoptional
updatedAtstringoptional
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
patch/api/v1/reviews/widgets/{id}
Ihr API-Schlüssel
id *
Anfragetext
{}
v1Ressourcen/Reviews/deleteBewertungs-Widget löschen

Löscht ein Bewertungs-Widget dauerhaft. Die öffentliche Einbettung wird danach nicht mehr ausgeliefert.

Bewertungs-Widget löschen

delete/api/v1/reviews/widgets/{id}
reviews:write
Query-Parameter
idstringerforderlich
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
delete/api/v1/reviews/widgets/{id}
Ihr API-Schlüssel
id *
{}
v1Ressourcen/Reviews/postAuf eine Bewertung antworten

Veröffentlicht eine Antwort des Unternehmens auf eine Bewertung und übermittelt sie an die Quellplattform. Schlägt mit einem Geschäftsregel-Fehler (422) fehl, wenn auf die Bewertung nicht geantwortet werden kann — z. B. weil sie aus ihrer Quelle entfernt wurde.

Auf eine Bewertung antworten

post/api/v1/reviews/reply
reviews:write
Anfragetext
reviewIdstringerforderlich
Die Bewertung, auf die geantwortet werden soll. Erforderlich.
textstringerforderlich
Der zu veröffentlichende Antworttext. Erforderlich.
Antwort
dataobjectoptional
okbooleanoptional
Ob die Antwort akzeptiert wurde.
pushedbooleanoptional
Ob die Antwort tatsächlich an die Quellplattform übertragen wurde (statt nur in die Warteschlange gestellt).
statusstring (posted | pending | failed | draft)optional
Einer von: posted, pending, failed, draft.
externalReplyIdstringoptional
Die ID der Antwort auf der Quellplattform, oder null.
retryablebooleanoptional
Falls die Übertragung fehlgeschlagen ist, ob ein erneuter Versuch erfolgreich sein könnte — null, wenn nicht zutreffend.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
422Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/reviews/reply
Ihr API-Schlüssel
Anfragetext*
{}