Synup
Créer une clé
v1Ressources/Invitations à laisser un avis/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/api/v1/review-invites/rollup
review-invite:read
Paramètres de requête
clientIdstringfacultatif
The client to roll up.
tagstringfacultatif
Only locations with this tag.
fromstringfacultatif
The start of the window, a date.
tostringfacultatif
The end of the window, a date.
Réponse
dataobjectfacultatif
funnelobjectfacultatif
Sent, delivered, opened, clicked and reviewed counts.
channelsobjectfacultatif
Email versus SMS effectiveness.
deliverabilityobjectfacultatif
Bounces, failures and unsubscribes.
locationsarray of objectfacultatif
A row per location.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/review-invites/rollup
Votre clé API
clientId
tag
from
to
{}

Guides qui utilisent cette ressource