INinboxpro
Campaigns

Campaign detail

Totals for one campaign, plus why emails bounced and which links were clicked. Pass the subject line exactly as the campaign list returns it.

get/v1/domains/{domain}/campaigns/detail

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

subjectstring required

The exact subject line of the campaign, as returned by the campaigns list.

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
data_as_ofstring date-time required

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

Example response

{
  "domain": "example.com",
  "campaign": {
    "subject": "October newsletter"
  },
  "bounce_reasons": [
    {
      "reason": "invalid_recipient",
      "label": "Mailbox does not exist",
      "count": 12
    }
  ],
  "links": [
    {
      "url": "https://example.com/offer",
      "label": "Shop now",
      "clicks": 104,
      "recipients": 87
    }
  ]
}

Changes

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