v1Resources/Review Invites/getRead campaign analytics
Read campaign analytics
Requires ReviewGen and Reviews access to the campaign’s owning client. Returns saved configuration, delivery/response statistics and available analytics. Unavailable metrics remain null; this read does not send or collect data.
get
review-invite:read/api/v1/review-invites/campaigns/{id}/analyticsQuery parameters
idstringrequired
Response
dataobjectoptional
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.
404The resource wasn't found, or doesn't belong to your agency.
409The record changed, delivery requires approval, or the operation conflicts with existing state.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The invitation operation could not be completed. An uncertain CRM queue result retains runId; check it before retrying.
get/api/v1/review-invites/campaigns/{id}/analytics
Your API key
id *
{}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.