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/api/v1/review-invites/rollup
review-invite:read
Pará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.
Respuesta
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.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/review-invites/rollup
Su clave de API
clientId
tag
from
to
{}

Guías que usan este recurso