v1Ressourcen/Review Invites/getRoll up invite performance
Roll up invite performance
Returns invite performance for a client or tag in one read: the funnel, email versus SMS effectiveness, deliverability and a per-location table. A key limited to specific clients must name a client.
get
review-invite:read/api/v1/review-invites/rollupQuery-Parameter
clientIdstringoptional
The client to roll up.
tagstringoptional
Only locations with this tag.
fromstringoptional
The start of the window, a date.
tostringoptional
The end of the window, a date.
Antwort
dataobjectoptional
funnelobjectoptional
Sent, delivered, opened, clicked and reviewed counts.
channelsobjectoptional
Email versus SMS effectiveness.
deliverabilityobjectoptional
Bounces, failures and unsubscribes.
locationsarray of objectoptional
A row per location.
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/review-invites/rollup
Ihr API-Schlüssel
clientId
tag
from
to
{}Anleitungen, die diese Ressource verwenden
- How to Build a Reputation Management PlatformArchitecture and API calls for a multi-client reputation management platform on Synup: review ingestion, reply workflows, invites, widgets and reporting.
- Send a Review Invite via APIAdd a customer to a review-invite campaign with the Synup API once a visit completes, and the domain and number verification that gating requires.