MailPilot API

Get mailbox report

Sent/delivered/replied/bounced/spam KPIs, daily volume, folder placement, and an ESP-by-ESP breakdown for one mailbox.

GET
/api/email-accounts/{id}/report

Sent/delivered/replied/bounced/spam KPIs, daily volume, folder placement, and an ESP-by-ESP breakdown for one mailbox.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

An API key generated from Settings → API Keys in the MailPilot dashboard, sent as Authorization Bearer <key>.

In: header

Path Parameters

id*integer

Mailbox ID.

Query Parameters

range?string

Ignored if from/to are provided.

Default"30d"

Value in

  • "7d"
  • "30d"
  • "60d"
  • "90d"
from?string

Start date (inclusive), used together with to for a custom range.

Formatdate
to?string
Formatdate

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/email-accounts/0/report"
{  "data": {    "kpis": {      "sent": 0,      "delivered": 0,      "received": 0,      "replied": 0,      "undelivered": 0,      "spam": 0,      "savedFromSpam": 0,      "savedFromOther": 0    },    "volumeByDay": [      {        "date": "2019-08-24",        "sent": 0,        "replied": 0,        "undelivered": 0,        "spam": 0,        "other": 0      }    ],    "folderPlacement": {      "inbox": 0,      "spam": 0,      "total": 0    },    "espBreakdown": [      {        "espType": "string",        "sent": 0,        "delivered": 0,        "replied": 0,        "inbox": 0,        "spam": 0,        "undelivered": 0,        "replyRate": 0,        "deliverabilityRate": 0      }    ]  }}