v1

latestOpenAPI 3.1.02026-07-24700259.3 KB

STATISTICS

Email history

Retrieve a summary of activity from a specified date range (defaults to last 30 days), per sender email address, SMTP username, domain or subaccount.

post/stats/email_history

Request body

group_bystring

One of [<code>email_address</code>, <code>username</code>, <code>domain</code>, <code>subaccount</code>] - controls the grouping of results. Defaults to <code>email_address</code>

start_datestring

ISO-8601 formatted datetime which defaults to 30 days prior to the current date at midnight. Timezone is UTC

end_datestring

ISO-8601 formatted datetime which defaults the current time. Timezone is UTC

Response

Summary of Account

request_idstring required

Example response

{
  "request_id": "f3898083-f5d5-4512-86bd-e02bd1685840",
  "data": {
    "count": 159,
    "bounce_percent_total": 1.24,
    "open_percent_total": 1.24,
    "reject_percent_total": 1.24,
    "spam_percent_total": 1.24,
    "unsubscribe_percent_total": 1.24,
    "history": [
      {
        "subaccount": "My Subaccount Name",
        "domain": "test.com",
        "domain_verified": true,
        "lastip": "55.67.22.12",
        "used": 123,
        "email_address": "test3@example.com",
        "username": "my_user",
        "bytecount": 148113,
        "avgsize": 1204.1707317073171,
        "bounces": 123,
        "clicks": 123,
        "opens": 123,
        "rejects": 123,
        "spam": 123,
        "unsubscribes": 123,
        "bounce_percent": 1.24,
        "open_percent": 1.24,
        "reject_percent": 1.24,
        "spam_percent": 1.24,
        "unsubscribe_percent": 1.24
      }
    ]
  }
}