Overview

Domain summary

Totals and rates for everything sent from one domain over a period: deliveries, bounces, opens, clicks, and unsubscribes.

get/v1/domains/{domain}/summary

Request

  • Base URL
    https://data.inboxpro.io
  • Auth
    HTTP bearer

Path parameters

domainstring required

One of your sending domains (the part after @ in your From address).

Query parameters

fromstring date

First day to include, YYYY-MM-DD (UTC). Defaults to 6 days before to.

tostring date

Last day to include, YYYY-MM-DD (UTC). Defaults to today. The range can span at most 90 days.

exclude_botsboolean

Leave out opens and clicks made automatically by security scanners and mail privacy features, so engagement reflects real people. Set to false to count every open and click.

Response

Default Response

domainstring required
bots_excludedboolean required

Whether automated opens and clicks were left out.

data_as_ofstring date-time required

Numbers include activity up to this moment. Recent hours may still change slightly.

first_sent_atstring date-time nullable

First email sent in the period.

last_sent_atstring date-time nullable

Last email sent in the period.

Example response

{
  "domain": "example.com"
}

Changes

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