GET
/
report
/
campaign
/
{campaignId}
Get Campaign Report Data
curl --request GET \
  --url https://api.sendx.io/api/v1/rest/report/campaign/{campaignId} \
  --header 'X-Team-ApiKey: <api-key>'
{
  "campaignId": "sendx123",
  "linkStats": {
    "www.example.com": 123
  },
  "clickedContactCount": 230,
  "openedContactCount": 345,
  "repliedContactCount": 12,
  "clickedUniqueContactCount": 210,
  "openedUniqueContactCount": 320,
  "repliedUniqueContactCount": 11,
  "sentContactCount": 500,
  "unsubscribeContactCount": 10,
  "bounceContactCount": 5,
  "spamContactCount": 2,
  "emailRevenue": "$5000",
  "revenuePerRecipient": "$10",
  "currency": "USD"
}

Authorizations

​
X-Team-ApiKey
string
header
required

Path Parameters

​
campaignId
string
required

The ID of the campaign to retrieve the report data for

Query Parameters

​
integrationType
string

Type of integration for the report data (optional)

Response

200
application/json

Get Report Data Successfully

Contains the report data for a given campaign