v1Recursos/Review Invites/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/api/v1/review-invites/campaigns/{id}/delivery
review-invite:read
Parámetros de consulta
idstringobligatorio
The campaign's id.
outcomestring (pending | skipped | sent | delivered | bounced | failed | unsubscribed)opcional
Only recipients with this outcome.
pageintegeropcional
The page number, from 1.
perPageintegeropcional
Recipients per page.
Respuesta
dataobjectopcional
recipientsarray of objectopcional
The recipients with their outcome.
totalintegeropcional
How many match.
pageintegeropcional
This page's number.
perPageintegeropcional
How many a page holds.
hasMorebooleanopcional
True when there is another page.
countsobjectopcional
How many recipients have each outcome, across the whole campaign.
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.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/review-invites/campaigns/{id}/delivery
Su clave de API
id *
outcome
page
perPage
{}

Guías que usan este recurso