Campaigns

Status and statistics

Permission required: campaigns:read. Rates are calculated on delivered messages, not on recipients: a dead address must not pull down the open rate of those who did receive it. open_rate and click_rate include bots, as most tools count them; human_open_rate and human_click_rate set them aside.

get/api/v1/campaigns/{id}

Request

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

Path parameters

idstring required

Response

The campaign.

idstring
object'campaign'
namestring
subjectstring nullable
kindstring
status'draft' | 'scheduled' | 'sending' | 'sent' | 'archived'
fromstring nullable
scheduled_atstring date-time nullable
sent_atstring date-time nullable
created_atstring date-time
schedule_errorstring nullable

Why a scheduled send did not go out.

Changes

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