GET /api/campaign.php
Request parameters
All parameters must be provided as query arguments, and values must be URL-encoded.
Parameter | Value |
id | Unique ID of campaign, which is returned on launch. Can be found with Campaign API list request. Required. |
detailed | Include recipients detailed open/click statistics with response. Value can be either 0 or 1. |
offset | Number of records to skip for request. Defaults to 0. Value of 0 returns records from 0 to 10 000, 1 returns records from 10 001 to 20 000, etc. |
limit | Number of records to return per request. Value defaults to 10000, and is capped at 10000. |
Note! Parameters offset and limit are only applied when detailed parameter has value of 1.
Response payload
Parameter | Value |
id | Unique ID of the campaign. |
name | Campaign title and subject. |
from | Sender address. Read "Sender address object parameters" section for more information. |
reply_to | Reply-To address. |
template | Template used in the campaign. Read "Template object parameters" section for more information. |
google_analytics_tracking | Google Analytics tracking settings. See "Google Analytics object parameters" section for more information. |
status | Status. Possible values: DRAFT, PENDING - sending still in progress, COMPLETED, CANCELLED. |
created_at | Creation date. Formatted as YYYY-MM-DD HH:MM:SS. |
completed_at | Completion date. Parameter has value only when campaign's status is COMPLETED. Formatted as YYYY-MM-DD HH:MM:SS. |
total_count | Total number of campaign messages. |
delivered_count | Number of messages successfully delivered. |
bounce_count | Number of messages bounced. |
click_count | Number of link clicks. |
unique_click_count | Number of recipients who have clicked at least one link. |
click_percent | Percentage of recipients who have clicked at least one link. unique_click_count divided by delivered_count. |
view_count | Number of times message images were downloaded. |
unique_view_count | Number of recipients who have downloaded images at least one time. |
view_percent | Percentage of recipients who have downloaded images at least one time. unique_view_count divided by delivered_count. |
opened_count | Number of recipients who have opened the messages (clicked a link or downloaded images at least once). |
opened_percent | Percentage of recipients who have opened the message. opened_count divided by delivered_count. |
unsubscribe_count | Number of unsubscribed recipients. |
complaint_count | Number of recipients who reported message as spam. |
forward_count | Number of times message was forwarded. |
addresses | List of detailed statistics per recipient. Added only when request parameter detailed is 1. Read "Addreses object parameters" section for more information. |
Sender address object parameters
Parameter | Value |
email | Sender's email address. |
name | Sender's name. Can be empty. |
Template object parameters
Parameter | Value |
id | Template ID. Numeric |
name | Template name. |
preview_url | URL to template preview. |
Google Analytics object parameters
Parameter | Value |
enabled | Google Analytics tracking enabled status. |
utm_campaign | Google Analytics utm_campaign parameter value. Is NULL if not set. |
Addresses object parameters
Parameter | Value |
email | Recipients email address. |
sent_at | Message delivery date and time. Formatted as YYYY-MM-DD HH:MM:SS, and presented in Europe/Tallinn timezone. |
opens | Number of times recipient opened message. |
clicks | Number of times recipient clicked link(s). |
links | List of links clicked by recipient. See "Links object parameters" for more information. |
Links object parameters
Parameter | Value |
href | Link's URL. |
visit_at | Date and time of first click. Formatted as YYYY-MM-DD HH:MM:SS, and presented in Europe/Tallinn timezone. |
count | Number of times link has been clicked. |
Example request
curl -X GET -u '[username]:[password]' https://[subdomain].sendsmaily.net/api/campaign.php?id=[id]&detailed=1
Example response
{
"id": "5",
"name": "My First Campaign",
"from": {
"email": "sender@example.com",
"name": "John Doe"
},
"reply_to": "hello@example.com",
"template": {
"id": 1,
"name": "Welcome message template",
"preview_url": "https:\/\/[subdomain].sendsmaily.net\/template\/preview\/id\/1"
},
"status": "COMPLETED",
"created_at": "2020-03-25 09:03:00",
"completed_at": "2020-03-25 10:00:00",
"google_analytics_tracking": {
"enabled": true,
"utm_campaign": "201903_spring_campaign"
},
"total_count": 10445,
"delivered_count": 10400,
"bounce_count": 45,
"click_count": 330,
"unique_click_count": 123,
"click_percent": 1.18,
"view_count": 3220,
"unique_view_count": 2765,
"view_percent": 26.59,
"opened_count": 2833,
"opened_percent": 27.24,
"unsubscribe_count": 3,
"complaint_count": 0,
"forward_count": 0,
"addresses": [
{
"email": "support@smaily.com",
"sent_at": "2019-03-10 11:34:15",
"opens": 3,
"clicks": 1,
"links": [
{
"href": "https:\/\/smaily.com",
"visit_at": "2019-03-10 13:07:11",
"count": 1
}
]
},
...
]
}