After a campaign has been successfully delivered, analytics data for the campaign will become available. This data includes a summary of subscriber interactions, such as reads, clicks, and bounces.
The analytics summary API call provides headline figures of subscriber interactions relating to a specific campaign.
This request can be made with a GET call against the following URL:
After a successful request, the following JSON response will be returned:
{
"status":"ok",
"data":{
"campaign_id":"1357",
"total_sent":"6782",
"delivered":6705,
"delivered_percent":98.86,
"reads":"5967",
"reads_percent":88.99,
"reads_on_mobile":"3067",
"reads_on_mobile_percent":36.55,
"reads_on_desktop":"2801",
"reads_on_desktop_percent":36.55,
"reads_on_tablet":"89",
"reads_on_tablet_percent":7.6,
"clicks":"53",
"clicks_percent":15.5,
"social_clicks_facebook":4,
"social_clicks_googleplus":9,
"social_clicks_instagram":4,
"social_clicks_linkedIn":6,
"social_clicks_pinterest":4,
"social_clicks_twitter":11,
"social_clicks_youtube":7,
"unsubscribes":"38",
"unsubscribes_percent":0.77,
"soft_bounces":65,
"soft_bounces_percent":1.05,
"hard_bounces":12,
"hard_bounces_percent":0.34
}
}This request provides a detailed report on subscriber interactions related to a specific campaign.
You can request data with a GET call to the following URL:
After a successful request, the following JSON response will be returned:
{
"status": "ok",
"sent_date": "25/07/2024",
"campaign_id": 880,
"list_name": "Web Subscribers",
"list_id": 27,
"page": 1,
"total_pages": 1,
"subscribers": [
{
"id": 1397807,
"salutation": "Mr",
"first_name": "Fidget",
"surname": "von Wigglesworth",
"company": "Wiggles Ltd",
"ref": "",
"email": "fidgetvw@example.com",
"mobile": "",
"custom_fields": {
"region": "UK",
"account manager" : "Monty Parker"
},
"tags": "18,36",
"status": "active",
"analytics_read": true,
"analytics_unsubscribe": false,
"analytics_bounce": false,
"analytics_clicks": []
},
{
"id": 1397806,
"salutation": "Mrs",
"first_name": "Zara",
"surname": "Zoomington",
"company": "",
"ref": "",
"email": "zarazoom@example.com",
"mobile": "",
"custom_fields": {
"region": "UK",
"account manager" : "Monty Parker"
},
"tags": "18,23",
"status": "active",
"analytics_read": false,
"analytics_unsubscribe": false,
"analytics_bounce": false,
"analytics_clicks": []
},
{
"id": 1397804,
"salutation": "Dr",
"first_name": "Maximus",
"surname": "Funsworth",
"company": "Fun Stock",
"ref": "",
"email": "maximusfun@example.com",
"mobile": "",
"custom_fields": "",
"tags": "1,3",
"status": "bounce",
"analytics_read": false,
"analytics_unsubscribe": false,
"analytics_bounce": true,
"analytics_clicks": []
},
{
"id": 1397803,
"salutation": "Mr",
"first_name": "Whimsy",
"surname": "Wobblebottom",
"company": "",
"ref": "",
"email": "whimsywobble@example.com",
"mobile": "",
"custom_fields": "",
"tags": "",
"status": "active",
"analytics_read": true,
"analytics_unsubscribe": true,
"analytics_bounce": false,
"analytics_clicks": [
"https://www.example.co.uk/contact",
"https://www.example.co.uk"
]
},
{
"id": 1397801,
"salutation": "Mr",
"first_name": "Waldo",
"surname": "Wifflebottom",
"company": "",
"ref": "",
"email": "waldowiffle@example.com",
"mobile": "",
"custom_fields": "",
"tags": "",
"status": "active",
"analytics_read": true,
"analytics_unsubscribe": false,
"analytics_bounce": false,
"analytics_clicks": []
},
{
"id": 1397798,
"salutation": "Mr",
"first_name": "Giggles",
"surname": "McGuffin",
"company": "",
"ref": "",
"email": "gigglesmcguffin@example.com",
"mobile": "",
"custom_fields": "",
"tags": "",
"status": "active",
"analytics_read": true,
"analytics_unsubscribe": false,
"analytics_bounce": false,
"analytics_clicks": [
"https://www.example.co.uk/product/1",
"https://www.example.co.uk/product/2"
]
}
]
}The subscribers object returned includes a breakdown of each subscriber's interactions with your campaign, along with their attached mail merge data. Additionally, associated analytics data for each subscriber is returned in boolean format. If a subscriber clicked on a link within your campaign, the analytics_click object will return the URLs that were clicked.