Skip to main content
GET
/
report
/
campaign
/
{identifier}
Get campaign report
curl --request GET \
  --url https://api.sendx.io/api/v1/rest/report/campaign/{identifier} \
  --header 'X-Team-ApiKey: <api-key>'
{
  "campaignId": "campaign_6h8DnYrHt4KktCnG8PDO5Z",
  "linkStats": [
    {
      "url": "https://sendx.io",
      "count": 10
    }
  ],
  "clickedUniqueContactCount": 10,
  "openedUniqueContactCount": 14,
  "sentContactCount": 20,
  "unsubscribeContactCount": 5,
  "bounceContactCount": 3,
  "spamContactCount": 2,
  "clickedContactCount": 10,
  "openedContactCount": 14
}
🎯 Key Features:
  • Open and click rates
  • Unsubscribe and bounce rates
  • Link-level click tracking
  • Geolocation data

Authorizations

​
X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

X-Team-ApiKey: your_team_api_key_here

Path Parameters

​
identifier
string
required

Resource identifier with prefix (e.g., contact_BnKjkbBBS500CoBCP0oChQ)

Format: <prefix>_<22-character-id>

Example:

"contact_BnKjkbBBS500CoBCP0oChQ"

Response

✅ Report retrieved successfully

​
campaignId
string

Unique identifier of the campaign

Example:

"campaign_6h8DnYrHt4KktCnG8PDO5Z"

​
linkStats
object[]
​
clickedUniqueContactCount
integer

Total number of unique contacts who clicked on the link

Example:

10

​
openedUniqueContactCount
integer

Total number of unique contacts who opened the link

Example:

14

​
sentContactCount
integer

Total number of contacts who sent the link

Example:

20

​
unsubscribeContactCount
integer

Total number of contacts who unsubscribed from the link

Example:

5

​
bounceContactCount
integer

Total number of contacts who bounced the link

Example:

3

​
spamContactCount
integer

Total number of contacts who marked the link as spam

Example:

2

​
clickedContactCount
integer

Total number of contacts who clicked on the link

Example:

10

​
openedContactCount
integer

Total number of contacts who opened the link

Example:

14

⌘I