Emails

Status of an email

Permission required: emails:send. The status changes after the send, as our provider reports back. With a test key, only test emails are found; a live key never sees them.

get/api/v1/emails/{id}

Request

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

Path parameters

idstring required

Response

The email.

idstring

The identifier to pass back to GET /api/v1/emails/{id} to learn about delivery.

object'email'
fromstring
tostring[]

Always an array in the response, even if you passed a single address.

subjectstring
created_atstring date-time
status'queued' | 'sent' | 'delivered' | 'opened' | 'bounced' | 'complained' | 'failed'

queued on acceptance, then sent, delivered, opened, bounced, complained or failed as our provider reports back. Expect a few seconds before delivered. With several addresses, it follows the recipients in to only: a copy (cc, bcc) that bounces does not change it — read recipients for each address.

errorstring nullable

The reason for the refusal, when status is bounced, complained or failed. null otherwise.

tagsobject nullable

The send's tags, after forbidden characters were rewritten.

sent_atstring date-time nullable
delivered_atstring date-time nullable
opened_atstring date-time nullable

The first open, bots included.

open_countinteger

How many times the tracking pixel was loaded. Apple and Gmail preload images: this says attention, not readings.

human_opened_atstring date-time nullable

The first open by a person — null as long as only bots have opened.

track_opensboolean

Whether this email carried an open-tracking pixel. false: opened_at stays null because opens are not tracked, not because nobody opened.

track_clicksboolean

Whether this email's links were tracked (track_clicks).

click_countinteger

How many times a tracked link was clicked, bots included.

clicked_atstring date-time nullable

The first click, bots included.

human_clicked_atstring date-time nullable

The first click by a person — null as long as only bots have clicked.

Changes

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