v1Recursos/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/rollupParâmetros de consulta
clientIdstringopcional
The client to roll up.
tagstringopcional
Only locations with this tag.
fromstringopcional
The start of the window, a date.
tostringopcional
The end of the window, a date.
Resposta
dataobjectopcional
funnelobjectopcional
Sent, delivered, opened, clicked and reviewed counts.
channelsobjectopcional
Email versus SMS effectiveness.
deliverabilityobjectopcional
Bounces, failures and unsubscribes.
locationsarray of objectopcional
A row per location.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/review-invites/rollup
Sua chave de API
clientId
tag
from
to
{}Guias que usam este recurso
- 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.