INinboxpro
Recipients

Who clicked

Recipients who clicked a link in the campaign, those who clicked most often first.

An unknown subject returns an empty list. Requires an API key with the recipients:read permission.

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

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.

pageinteger

Page number, starting at 1.

page_sizeinteger

Rows per page (max 100).

Response

Default Response

domainstring required
subjectstring 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

{
  "recipients": [
    {
      "email": "jane@example.org",
      "clicks": 2,
      "links": [
        {
          "url": "https://example.com/offer",
          "label": "Shop now",
          "clicks": 1
        }
      ]
    }
  ]
}

Changes

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