MAILINGS — REPORT
Provide data about open, clicks, complaints, or deliverability for a specific mailing.
HTTP VERB
Get
URL
/API/Rest/Mailings/Report
ARGUMENTS
mailingTitle
reportType
Required permission
StandardReports
ERRORS
No Permission
Invalid report type. Options: Clicks, Opens, Deliverability, Complaints
Invalid mailing title
Error in processing
Too many API calls
Database error
Unknown error
RETURNS
Details for the mailing. Each of the reports returns the email address, name field, and the date of the activity. Each of the repots varies slightly. The Deliverability report has the status of the send attempt. The Clicks report includes the URL and the alias for the URL, if specified.
Clicks
Email Address Name URL Timestamp URL alias
{"downloadGuid":"d2746c93-1e91-4e7f-b417-71586f6969ba","totalRows":7,
"userData":[["kent@aol.com","Kent Example","https://www.example.com/gdpr","5/2/2018 2:47 PM",""],
["wayne@att.net","","https://www.example.com/gdpr","5/2/2018 4:07 PM",""],
["eddie@aol.com","Eddie Example","https://www.example.com/gdpr","5/3/2018 12:58 AM",""],
["aaron@msn.com","Aaron Example","https://www.example.com/gdpr","5/3/2018 3:06 AM",""],
["Joe@aol.com","Joe Example","https://www.example.com/gdpr","5/3/2018 5:49 AM",""],
["fred@aol.com","","https://www.example.com/gdpr","5/3/2018 11:54 AM",""],
["sam@aol.com","","https://www.example.com/gdpr","5/4/2018 5:55 PM",""]]}
Opens
Email address Name Timestamp
{"downloadGuid":"7a397d2b-9a9f-4ae1-a4d3-cf44cffd5b8f","totalRows":6,
"userData":[["aaron@example.com","Aaron Example","5/2/2018 1:45 PM"],
["dave@yahoo.com","","5/17/2018 9:08 AM"],
["ben@aol.com","","5/2/2018 1:49 PM"],
["carol@aol.com","Carol Example","5/3/2018 12:32 AM"],
["al@yahoo.com","Al Example","5/2/2018 10:22 PM"],
["dave@msn.com","","5/2/2018 1:24 PM"]]}
Deliverability
Email address Name Status Timestamp
{"downloadGuid":"5bad0a0e-afa0-40ed-9a71-f78dba8a9a11","totalRows":7,
"userData":[["joe@example.com","Joe Example","Success", "5/2/2018 1:15 PM"],
["sam@aol.com","","Success","5/2/2018 1:15 PM"],
["al@aol.com","","Unknown user","5/2/2018 1:15 PM"],
["dave@msn.com","","Success","5/2/2018 1:15 PM"],
["fred@yahoo.com","","Unknown user","5/2/2018 1:16 PM"],
["abe@aol.com","Abe Example","Success","5/2/2018 1:15 PM"],
["matt@aol.com","Matt Example","Unknown user","5/2/2018 1:15 PM"]]}
Complaints
Email address Name Timestamp
{"downloadGuid":"a7323990-2277-4e54-9026-3af3f144fc49","totalRows":2,
"userData":[["joe@aol.com","Joe Example","9/6/2018 3:56 AM"],
["Preston@aol.com","Preston Example","7/9/2018 2:10 PM"]]}
EXAMPLE
Get the clicks for a specific mailing.
string url = "http://example.com/api/rest/Mailings/Report?accountName=acme&login=ApiUser&mailingTitle=Test1&reportType=Clicks";
try
{
System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
request.Headers.Add("Password", "34teh6i6j565ydw4h");
using (System.Net.WebResponse response = request.GetResponse())
using (Stream responseStream = response.GetResponseStream())
using (StreamReader reader = new StreamReader(responseStream, Encoding.UTF8))
System.Console.WriteLine(reader.ReadToEnd());
}
catch (System.Net.WebException ex)
{
System.Diagnostics.Debug.Fail(ex.Message);
}
# encoding: utf-8
require 'rest-client'
require 'json'
url = 'http://example.com/api/rest/Mailings/Report/?accountName=acme&login=ApiUser&mailingTitle=Test1&reportType=Clicks'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response
import requests
url = "http://www.example.com/api/rest/Mailings/Report/?accountName=acme&login=ApiUser&mailingTitle=Test1&reportType=Clicks";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
print resp.text
http://example.com/api/rest/Mailings/Report/?accountName=acme &login=ApiUser &password=sdff34fg34s &mailingTitle=Test1 &reportType=Clicks