Synup
Schlüssel erstellen
v1Ressourcen/Reviews/getBewertungs-Widget abrufen

Bewertungs-Widget abrufen

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

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 *
{
  "data": {
    "widget": {
      "id": "cm_widget_1",
      "agencyId": "cm_agency_1",
      "locationId": "cm_loc_1",
      "clientLocationId": "cm_loc_1",
      "name": "Homepage reviews",
      "minRating": 4,
      "sources": [
        "google"
      ],
      "selectionMode": "recent",
      "dateWindow": "all",
      "manualReviewIds": [],
      "count": 10,
      "layout": "carousel",
      "theme": "brand",
      "themeOverrides": null,
      "showFlags": null,
      "status": "published",
      "includeInternal": false,
      "emojiPositiveRating": 4,
      "marqueeSpeed": 5,
      "createdAt": "2026-01-15T09:00:00.000Z",
      "updatedAt": "2026-01-15T09:00:00.000Z",
      "createdByUserId": "cm_user_1",
      "createdByType": "user"
    }
  }
}

Anleitungen, die diese Ressource verwenden