v1Ressources/Invitations à laisser un avis/getList a campaign's delivery outcomes
List a campaign's delivery outcomes
Lists each recipient's outcome — pending, skipped, sent, delivered, bounced, failed or unsubscribed — with the reason for a bounce or failure and whether the contact can be corrected. The counts cover the whole campaign.
get
review-invite:read/api/v1/review-invites/campaigns/{id}/deliveryParamètres de requête
idstringobligatoire
The campaign's id.
outcomestring (pending | skipped | sent | delivered | bounced | failed | unsubscribed)facultatif
Only recipients with this outcome.
pageintegerfacultatif
The page number, from 1.
perPageintegerfacultatif
Recipients per page.
Réponse
dataobjectfacultatif
recipientsarray of objectfacultatif
The recipients with their outcome.
totalintegerfacultatif
How many match.
pageintegerfacultatif
This page's number.
perPageintegerfacultatif
How many a page holds.
hasMorebooleanfacultatif
True when there is another page.
countsobjectfacultatif
How many recipients have each outcome, across the whole campaign.
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
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/campaigns/{id}/delivery
Votre clé API
id *
outcome
page
perPage
{}Guides qui utilisent cette ressource
- 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.