v1Resources/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 parameters
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.
Response
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.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/review-invites/rollup
Your API key
clientId
tag
from
to
{}Guides that use this resource
- 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.