Campaigns

Recipients, one by one

Permission required: campaigns:read. Who the campaign went to and what each person did with it: delivered, opened, clicked, bounced, complained, unsubscribed. Cursor pagination, like /subscribers. opened_at and clicked_at include bots (security gateways, privacy relays); human_opened and human_clicked say whether a PERSON opened or clicked. email is null when the contact was deleted after the send: the row stays, because it still counts in the campaign's figures. unsubscribed is an attribution: the person unsubscribed after this email and before receiving another one (the unsubscribe link identifies the person, not the campaign). Cancelled messages are not recipients and are left out.

get/api/v1/campaigns/{id}/recipients

Request

  • Base URL: https://mailcheer.com
  • URL: https://mailcheer.com/api/v1/campaigns/{id}/recipients
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

idstring required

Query parameters

limitinteger

Number of items per page, from 1 to 100.

cursorstring

The next_cursor from the previous response.

status'opened' | 'clicked' | 'not_opened' | 'bounced' | 'complained' | 'unsubscribed'

Filter. opened and clicked include bots; not_opened: sent, not bounced, never opened.

Response

The requested page.

object'list'
has_moreboolean

One more page after this one.

next_cursorstring nullable

To pass back as ?cursor= for the next page. null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.