Campaigns

The full report

Permission required: campaigns:read. Everything the Mailcheer campaign view shows, so you can display it in your own software: counters, rates (shares between 0 and 1, null as long as nothing has gone out), the curve of the first 48 hours in eight six-hour windows (empty if the campaign has not gone out), what people read on (top five rows, shares between 0 and 1, proxiedShare = the share of opens coming from a privacy relay such as Apple Mail or Gmail), links from most to least clicked, and the HTML as rendered at send time (empty string otherwise). Every figure comes twice: bots included (opened, clicked — as most tools count) and without bots (humanOpened, humanClicked), with bots saying how many were set aside and why. Open and click rates are calculated on delivered messages; delivery and bounce rates on recipients.

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

Request

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

Path parameters

idstring required

Response

The report.

htmlstring

The HTML as rendered at send time; empty string as long as it does not exist.

Example response

{
  "timeline": [
    {
      "label": "+6h"
    }
  ]
}

Changes

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