Authentication
All requests must include an access-token parameter:
?access-token=YOUR_ACCESS_TOKEN
To obtain an access token, please contact: [email protected]
1. Campaign Send Statistics
Endpoint
GET https://api.intarget.app/rest/campaign/statistics
Description
Returns delivery and engagement statistics for one or multiple campaigns and messages.
Query Parameters
Parameter | Type | Required | Description |
access-token | string | Yes | API access token. |
startFrom | datetime | Optional | Campaign start datetime filter. (YYYY-MM-DD HH:MM:SS, URL-encoded) |
startTo | datetime | Optional | Campaign end datetime filter. |
campaignIds[] | integer[] | Optional | Filter by one or more campaign IDs. |
sendFrom | datetime | Optional | Filter by send date range start. |
sendTo | datetime | Optional | Filter by send date range end. |
perPage | integer | Optional | Max number of results per page, 10 by default |
Important: Always use either a date period (startFrom/startTo or sendFrom/sendTo) or campaignIds[].
Avoid unfiltered requests — they may be heavy and slow to process.
Example Requests
Filter by period
https://api.intarget.app/rest/campaign/statistics?startFrom=2025-03-12%2000:00:00&startTo=2025-03-19%2023:59:59&access-token=YOUR_ACCESS_TOKEN
Filter by campaign ID
https://api.intarget.app/rest/campaign/statistics?campaignIds[]=111&access-token=YOUR_ACCESS_TOKEN
Filter by send date
https://api.intarget.app/rest/campaign/statistics?sendFrom=2025-03-17%2000:00:00&sendTo=2025-03-19%2000:00:00&access-token=YOUR_ACCESS_TOKEN
Example Response
{
"campaign_id": 111,
"message_title": "Spring Promo — 25% Discount",
"type": "Email",
"campaign_start_at": "2025-03-17 10:04:21+00",
"skipped": 5,
"sent": 12500,
"delivered": 12340,
"opened": 5870,
"clicked": 1422,
"bounced": 160,
"softBounced": 73,
"complaint": 4,
"rejected": 12,
"unsubscribed": 27,
"failed": 85,
"temporaryFailed": 13
}
Response Field Definitions
Field | Type | Description |
campaign_id | integer | Unique campaign ID. |
message_title | string | Message Title |
type | string | Channel: Email, SMS, Push, etc. |
campaign_start_at | datetime | Start time of the campaign (UTC with offset). |
skipped | integer | Not processed due to no contact information or previously bounced/complaint/unsubscribed. |
sent | integer | Messages attempted to send. |
delivered | integer | Successfully delivered messages. |
opened | integer | Messages opened (only for Email/Push). |
clicked | integer | Messages with at least one click. |
bounced | integer | Total bounces. |
softBounced | integer | Temporary delivery failures (mailbox full, etc.). |
complaint | integer | Spam complaints / abuse reports. |
rejected | integer | Provider rejected delivery request. |
unsubscribed | integer | Recipients who unsubscribed after this campaign. |
failed | integer | Permanent delivery failures. |
temporaryFailed | integer | Temporary technical failures. |
2. Campaign Conversion Statistics
Endpoint
GET https://api.intarget.app/rest/campaign/statistic-conversions
Description
Returns conversion tracking metrics for campaigns based on a configured conversion event.
Query Parameters
Same as /campaign/statistics.
Parameter | Type | Required | Description |
access-token | string | Yes | API token. |
startFrom | datetime | Optional | Filter by campaign start datetime. |
startTo | datetime | Optional | Filter by campaign end datetime. |
campaignIds[] | integer[] | Optional | Campaign IDs to load. |
sendFrom | datetime | Optional | Filter by send date range. |
sendTo | datetime | Optional | End of send range. |
perPage | integer | Optional | Max number of results per page, 10 by default |
Important: Always filter either by period or by campaign IDs.
Avoid calling without filters — conversions dataset may be large.
Example Request
https://api.intarget.app/rest/campaign/statistic-conversions?campaignIds[]=1903&sendFrom=2025-10-13%2000:00:00&sendTo=2025-10-14%2023:59:59&access-token=YOUR_ACCESS_TOKEN
Example Response
{
"campaign_id": 1903,
"message_title": "Deposit Bonus — Get +30%",
"type": "Email",
"campaign_start_at": "2025-10-13 13:19:35+00",
"campaign_stop_at": "2025-10-14 06:00:00+00",
"campaign_name": "Email: Deposit Bonus October",
"conversion_event": "Opened",
"conversion_period": "1 day",
"deposits_count": "154",
"deposits_amount": "18752.40",
"converted_users": "102"
}
Response Field Definitions
Field | Type | Description |
campaign_id | integer | ID of the campaign. |
message_title | string | Outgoing message subject/title. |
type | string | Channel (Email/SMS/etc.). |
campaign_start_at | datetime | Start time of campaign execution. |
campaign_stop_at | datetime/null | End time (if applicable). |
campaign_name | string | Internal campaign name. |
conversion_event | string | Deposit Refcode/Delivered/Opened/Clicked |
conversion_period | string | Time window during which conversions are counted. |
deposits_count | string | Number of conversion events recorded. |
deposits_amount | string | Total monetary value of conversions. |
converted_users | string | Number of unique users who converted. |