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 API list request. Required.
detailedInclude recipients detailed open/click statistics with response. Value can be either 0 or 1.
offsetNumber 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.
limitNumber 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


ParameterValue
idUnique ID of the campaign.
nameCampaign title and subject.
fromSender address. Read "Sender address object parameters" section for more information.
reply_toReply-To address.
templateTemplate used in the campaign. Read "Template object parameters" section for more information.
google_analytics_trackingGoogle Analytics tracking settings. See "Google Analytics object parameters" section for more information.
statusStatus. Possible values: DRAFT, PENDING - sending still in progress, COMPLETED, CANCELLED.
created_atCreation date. Formatted as YYYY-MM-DD HH:MM:SS.
completed_atCompletion date. Parameter has value only when campaign's status is COMPLETED. Formatted as YYYY-MM-DD HH:MM:SS.
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. Read "Addreses object parameters" section for more information.


Sender address object parameters


ParameterValue
emailSender's email address.
nameSender's name. Can be empty.


Template object parameters


ParameterValue
idTemplate ID. Numeric
nameTemplate name.
preview_urlURL to template preview.


Google Analytics object parameters


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


Addresses object parameters


ParameterValue
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 "Links object parameters" for more information.


Links object parameters


ParameterValue
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


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
                }
            ]
        },
        ...
    ]
}