GET /api/campaign.php


Request parameters

All parameters must be provided as query arguments, and values must be URL-encoded.


ParameterValue
idUnique ID of campaign, which is returned on launch. Can be found with Campaign list API request. Required.
detailedInclude recipents detailed opens/clicks statistics with response. Value can be either 0 or 1.
offsetSo-called “page” number, which begins at 0. 0 gives contacts from 0 to 10000. 1 gives 10001 to 20000 etc. If not specified, 0 will be set.
limitNumber of subscribers on one “page”. If not specified, 10000 will be set, which is also the maximum value. If set as more than 10000, no error will be given, but the value will be defaulted back to 10000.


Note! Parameters offset and limit are only applied when detailed parameter has value of 1.


Response payload


FieldValue
idUnique ID of campaign.
nameCampaign title.
google_analytics_trackingGoogle Analytics tracking settings. See "Field google_analytics_tracking structure" for more information.
total_countTotal number of campaign messages.
delivered_countNumber of messages successfully delivered.
bounce_countNumber of messages bounced.
click_countNumber of link clicks.
unique_click_countNumber of recipients who have clicked at least one link.
click_percentPercentage of recipients who have clicked at least one link. unique_click_count divided by delivered_count.
view_countNumber of times message images were downloaded.
unique_view_countNumber of recipients who have downloaded images at least one time.
view_percentPercentage of recipients who have downloaded images at least one time. unique_view_count divided by delivered_count.
opened_countNumber of recipients who have opened the messages (clicked a link or downloaded images at least once).
opened_percentPercentage of recipients who have opened the message. opened_count divided by delivered_count.
unsubscribe_countNumber of unsubscribed recipients.
complaint_countNumber of recipients who reported message as spam.
forward_countNumber of times message was forwarded.
addressesList of detailed statistics per recipient. Added only when request parameter detailed is 1. See "Field addresses structure" section for more information.


Field google_analytics_tracking structure


FieldValue
enabledGoogle Analytics tracking enabled status.
utm_campaignGoogle Analytics utm_campaign parameter value. Is NULL if not set.


Field addresses structure


FieldValue
emailRecipients email address.
sent_atMessage delivery date and time. Formatted as YYYY-MM-DD HH:MM:SS, and presented in Europe/Tallinn timezone.
opensNumber of times recipient opened message.
clicksNumber of times recipient clicked link(s).
linksList of links clicked by recipient. See "Field links structure" for more information.


Field links structure


FieldValue
hrefLink's URL.
visit_atDate and time of first click. Formatted as YYYY-MM-DD HH:MM:SS, and presented in Europe/Tallinn timezone.
countNumber of times link has been clicked.


Example request


$username = 'YOUR_USERNAME';
$password = 'YOUR_PASSWORD';
$location = 'https://<subdomain>.sendsmaily.net/api/campaign.php';
$query = 'id=1&detailed=1';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $location . '?' . $query);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");

$result = curl_exec($ch);
curl_close($ch);


Example response


{
    "id": "5",
    "name": "My First Campaign",
    "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
                }
            ]
        },
        ...
    ]
}