Skip to content
Letterhead Letterhead Letterhead Help Center
Admin Tools

Get metrics

POST
/api/v3/metrics

Get metrics

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
Media type multipart/form-data
object
api

required | When set to true, this endpoint will accept authorization with your API Key.

string
Example 
true
channels[]

string[] | Optionally filter your metrics with a list of channels (by their identifiers).

string
Example 
{{channelSlug}}
direction

string | Change sort direction by optionally specifying “asc” or “desc.” Descending is default.

string
Example 
desc
from

required | string | Period start date (inclusive).

string
Example 
2026-02-26
groupBy

string | Pass channel to include per-channel breakdown

string
Example 
channel
limit

integer | Items per page for the channel breakdown. Max of 25.

string
Example 
5
page

integer | Page number for channel breakdown, as those will be paginated.

string
Example 
1
sortBy

string | Sort by “opens” or “channel” for a channel breakdown. Defaults to “opens.”

string
Example 
opens
to

required | string | Period end date (inclusive), must be >= from, max 90 days.

string
Example 
2026-03-26

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Get metrics / With channel breakdown

Media type application/json
object
items
object
channels
object
items
Array
total
number
currentPeriod
object
daily
Array<object>
object
accepted
number
bounced
number
clicks
number
clicksUnique
number
date
string
opensUnique
number
opensUniqueConfirmed
number
totals
object
accepted
number
bounced
number
clicks
number
clicksUnique
number
opensUnique
number
opensUniqueConfirmed
number
unsubscribes
number
priorPeriod
object
totals
object
accepted
number
bounced
number
clicks
number
clicksUnique
number
opensUnique
number
opensUniqueConfirmed
number
unsubscribes
number
message
string
total
number
Examples
{
  "items": {
    "currentPeriod": {
      "daily": [
        {
          "accepted": 0,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-02-27",
          "opensUnique": 0,
          "opensUniqueConfirmed": 0
        },
        {
          "accepted": 0,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-02-28",
          "opensUnique": 0,
          "opensUniqueConfirmed": 0
        },
        {
          "accepted": 0,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-01",
          "opensUnique": 0,
          "opensUniqueConfirmed": 0
        },
        {
          "accepted": 0,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-02",
          "opensUnique": 0,
          "opensUniqueConfirmed": 0
        },
        {
          "accepted": 0,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-05",
          "opensUnique": 0,
          "opensUniqueConfirmed": 0
        },
        {
          "accepted": 0,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-06",
          "opensUnique": 0,
          "opensUniqueConfirmed": 0
        },
        {
          "accepted": 0,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-07",
          "opensUnique": 0,
          "opensUniqueConfirmed": 0
        },
        {
          "accepted": 15,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-08",
          "opensUnique": 11,
          "opensUniqueConfirmed": 11
        },
        {
          "accepted": 13,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-09",
          "opensUnique": 9,
          "opensUniqueConfirmed": 9
        },
        {
          "accepted": 1,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-10",
          "opensUnique": 1,
          "opensUniqueConfirmed": 1
        },
        {
          "accepted": 0,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-11",
          "opensUnique": 0,
          "opensUniqueConfirmed": 0
        },
        {
          "accepted": 13,
          "bounced": 0,
          "clicks": 6,
          "clicksUnique": 2,
          "date": "2026-03-12",
          "opensUnique": 12,
          "opensUniqueConfirmed": 12
        },
        {
          "accepted": 13,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-13",
          "opensUnique": 12,
          "opensUniqueConfirmed": 12
        },
        {
          "accepted": 12,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-14",
          "opensUnique": 10,
          "opensUniqueConfirmed": 10
        },
        {
          "accepted": 14,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-15",
          "opensUnique": 11,
          "opensUniqueConfirmed": 11
        },
        {
          "accepted": 12,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-16",
          "opensUnique": 9,
          "opensUniqueConfirmed": 9
        },
        {
          "accepted": 5,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-17",
          "opensUnique": 4,
          "opensUniqueConfirmed": 4
        },
        {
          "accepted": 0,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-18",
          "opensUnique": 0,
          "opensUniqueConfirmed": 0
        },
        {
          "accepted": 12,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-19",
          "opensUnique": 11,
          "opensUniqueConfirmed": 11
        },
        {
          "accepted": 12,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-20",
          "opensUnique": 11,
          "opensUniqueConfirmed": 11
        },
        {
          "accepted": 12,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-21",
          "opensUnique": 10,
          "opensUniqueConfirmed": 10
        },
        {
          "accepted": 14,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-22",
          "opensUnique": 8,
          "opensUniqueConfirmed": 8
        },
        {
          "accepted": 12,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-23",
          "opensUnique": 9,
          "opensUniqueConfirmed": 9
        },
        {
          "accepted": 0,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-24",
          "opensUnique": 0,
          "opensUniqueConfirmed": 0
        },
        {
          "accepted": 0,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-25",
          "opensUnique": 0,
          "opensUniqueConfirmed": 0
        },
        {
          "accepted": 12,
          "bounced": 0,
          "clicks": 0,
          "clicksUnique": 0,
          "date": "2026-03-26",
          "opensUnique": 11,
          "opensUniqueConfirmed": 11
        }
      ],
      "totals": {
        "accepted": 172,
        "bounced": 0,
        "clicks": 6,
        "clicksUnique": 2,
        "opensUnique": 139,
        "opensUniqueConfirmed": 139,
        "unsubscribes": 0
      }
    },
    "priorPeriod": {
      "totals": {
        "accepted": 160,
        "bounced": 1,
        "clicks": 0,
        "clicksUnique": 0,
        "opensUnique": 119,
        "opensUniqueConfirmed": 117,
        "unsubscribes": 0
      }
    }
  },
  "message": "Do something kind today",
  "total": 1
}

Headers

Section titled “Headers ”
:status
string
Example 
200
access-control-allow-credentials
string
Example 
true
access-control-allow-origin
string
Example 
*
access-control-max-age
string
Example 
86400
alt-svc
string
Example 
h3=":443"; ma=2592000,h3-29=":443"; ma=2592000
cache-control
string
Example 
no-cache, private
date
string
Example 
Thu, 26 Mar 2026 19:10:35 GMT
server
string
Example 
nginx/1.27.3
via
string
Example 
1.1 google
x-powered-by
string
Example 
PHP/7.4.33

Still can’t find what you need? Contact support.