stats

Request various stats from Sailthru about natural list membership or campaign and transactional message activity.

Endpoint URL: https://api.sailthru.com/stats


GET Stats

GET mode is always used for this API call.

Required Parameters

Parameter Description Example
stat Which type of stat you wish to request list

Additional Parameters

Additional parameters are dependent on the stat value – the type of stats you want to request:


list

Retrieve information about your subscriber counts on all lists or a particular list, as counted on a specified day’s snapshot, defaulting to the current day.

Please note that subscriber counts are tracked only for primary lists. For more information, see Lists.

All Lists

Example Call:

{
 "stat":"list"
}

Single List

Example Call:

{
 "stat":"list",
 "list":"Master Marketing NA"
}

Response

Example Response:

{
    "day" : 20170106,
    "list" : "",
    "signup_month" : {
        "201612" : {
            "engaged_count" : 1637,
            "hardbounce_count" : 6237,
            "lists_count" : 100272,
            "email_count" : 91070,
            "dormant_count" : 34917,
            "optout_count" : 14186,
            "new_count" : 2939,
            "active_count" : 2810,
            "passive_count" : 10491,
            "disengaged_count" : 17853
        },
        "201611" : {
            "passive_count" : 17446,
            "email_count" : 170384,
            "lists_count" : 270327,
            "disengaged_count" : 48270,
            "engaged_count" : 1180,
            "dormant_count" : 56397,
            "optout_count" : 33555,
            "active_count" : 2724,
            "hardbounce_count" : 10812
        },
        "201610" : {
            "hardbounce_count" : 15061,
            "disengaged_count" : 87467,
            "engaged_count" : 1594,
            "lists_count" : 491592,
            "active_count" : 3845,
            "passive_count" : 27345,
            "dormant_count" : 78021,
            "email_count" : 273474,
            "optout_count" : 60141
        }
    },
    "spam_loss_count" : 46,
    "uum_horizon" : 436419,
    "valid_count" : 2952498,
    "dormant_count" : 1248649,
    "optout_count" : 1837528,
    "lists_remove_count" : 0,
    "email_count" : 5101740,
    "lists_count" : 31351070,
    "spam_count" : 30283,
    "new_count" : 12635,
    "uum" : 5658464,
    "engaged_count" : 16322,
    "passive_count" : 246992,
    "disengaged_count" : 1384300,
    "optout_loss_count" : 1983,
    "active_count" : 43505,
    "hardbounce_count" : 311699,
    "lists_signup_count" : 2940,
    "count_time" : "Fri, 06 Jan 2017 00:45:44 +0000"
}

The signup_month object shows all months, dating back to the creation of the list(s) requested, whether you are viewing stats for a specific list or all lists.

 

Optional Parameters

Parameter Description Example
list The name of the list to pull information about. If this parameter is left empty, you will retrieve information about all of your subscribers. my-list
date The date to pull information from. If this parameter is left empty, you will retrieve information from the most recent snapshot (today). Note that list subscriber count snapshots are calculated at midnight, so the data provided under a date could be considered to represent end-of-day data for the previous date. In the My.Sailthru reporting interface, the same data is labeled as representing that previous date. 2016-08-29

Return Value

A structure containing any or all of the following:

Field Description Example
active_count The number of active users 41772
day The day the count was made (generally around midnight) 20120929
disengaged_count The number of disengaged users 91723
dormant_count The number of dormant users 189760
email_count The total number of people on the list 515599
engaged_count The number of engaged users (will be 0 if you are not using Horizon) 0
hardbounce_count The number of users who are hardbounces 4423
list The name of the list, or an empty string if retrieving all subscribers my-list
lists_count The total number of subscriptions by all members of this list 2196518
lists_remove_count The number of users who were removed from this list in the past 24 hours 0
lists_signup_count The number of users who joined this list in the past 24 hours 7683
new_count The number of new users 5313
optout_count The number of users who are opt-outs 81931
optout_loss_count The number of users who opted out in the past 24 hours 81931
passive_count The number of passive users 68583
spam_count The number of users who were opted out because they marked a message as spam 341
source_signup The number of instances each ‘source’ value is set on a user. "sailthru": 19
source_signup_count The number of of users who signed up in the past 24 hours for each source. "sailthru": 1

blast

Retrieve information about a particular campaign or aggregated information from all campaigns over a specified date range.

Must specify either a blast_id or a start_date and end_date.

For more information on this, see API blast call.

Single Blast by ID

Example Call with Default Response Parameters

{
 "stat":"blast",
 "blast_id": 1881261
}

Example Response with Default Response Parameters

{
    "count" : 4,
    "open_total" : 4,
    "confirmed_opens" : 4,
    "estopens" : 4,
    "beacon" : 4
}

Example Call with All Optional Response Parameters

{
   "stat":"blast",
   "blast_id": 1881261,
   "beacon_times":1,
   "click_times":1,
   "clickmap":1,
   "domain":1,
   "engagement":1,
   "purchase_times":1,
   "signup":1,
   "subject":1,
   "topusers":1,
   "urls":1,
   "banners":1,
   "purchase_items":1,
   "device": 1
}

Simply drop any of the optional parameters above representing stats you do not need.

Blasts by Date Range

Example Call:

{
   "stat":"blast",
   "start_date":"2015-11-08",
   "end_date": "2015-11-08"
}

Example Response:

{
    "count" : 37839081,
    "click_total" : 412629,
    "click_multiple_urls" : 54634,
    "open_total" : 3403898,
    "pv" : 1997777,
    "optout" : 18727,
    "spam" : 6185,
    "hardbounce" : 6615,
    "softbounce" : 217810,
    "view" : 22828,
    "confirmed_opens" : 2751330,
    "estopens" : 2836507,
    "beacon" : 2744881,
    "click" : 214865,
    "rev" : 38688476,
    "purchase" : 6998,
    "purchase_first" : 2880,
    "purchase_price" : 38688476,
    "purchase_second" : 841
}

Optional Parameters

Parameter Description Example
blast_id The id of the blast to pull information from. Required if start_dateand end_dateare not specified. 123456
start_date The beginning of the date range from which to pull aggregated blast stats. Required if blast_idis not specified. 2012-09-29
end_date The beginning of the date range from which to pull aggregated blast stats. Required if blast_idis not specified. 2012-12-29
list Specify this option if you want to pull blast stats from one particular list. my-list
beacon_times Specify 1 to pull information about when a particular blast was opened. 1
click_times Specify 1 to pull information about when links were clicked. 1
clickmap Specify 1 to pull click map information. 1
domain Specify 1 to pull information based on recipients’ email domains. 1
engagement Specify 1 to pull information based on levels of engagement. 1
signup Specify 1 to pull information based on signup dates. 1
subject Specify 1 to pull information based on subject lines. 1
urls Specify 1 to pull information based on urls. 1
device Specify 1 to pull information based on the number of clicks by device. 1
topusers Specify 1 to pull information based on the top users based on clicks, opens and purchases. 1
banners Specify 1 to pull information based on your Ad Targeter banner performance. 1
purchase_times Specify 1 to pull information based on the purchase times for transactions related to this campaign. 1
purchase_items Specify 1 to pull information based on the items purchased from this campaign (quantity, url, etc.) 1

Return Value

A data structure including some or all of the following stats:

Field Description
count Number of users
beacon Number of users who opened with images turned on
estopens Sailthru’s estimate of number of users who opened your email
open_total Total number of beacon impressions (including multiple beacon impressions per user)
click Number of users who clicked at least one link
click_multiple_urls Number of users who clicked at least two different URLs
click_total Total number of clicks (including multiple clicks per user)
pv Number of pageviews generated
purchase Number of users who made a purchase
purchase_price Total amount of revenue generated from purchases (in cents)
rev Total amount of revenue generated (in cents)
softbounce Number of users who softbounced
hardbounce Number of users who hardbounced
optout Number of users who opted out
spam Number of users who reported spam
confirmed_opens Number of users who opened with images turned on or clicked
view Number of users who viewed the public version of the campaign at the {view_url}

send

Retrieve information about a particular transactional or aggregated information from transactionals from that template over a specified date range.

Must specify a template and a start_date and end_date.

For more on this, see API send call.

Get Transactional Stats

Example call with minimum required parameters:

{
   "stat" : "send",
   "template" : "Behavioral Abandoned Cart",
   "start_date" : "2015-01-01",
   "end_date" : "2016-12-31"
}

Example Response:

{
    "hardbounce" : 39,
    "softbounce" : 178,
    "optout" : 114,
    "spam" : 24,
    "count" : 226497,
    "pv" : 125087,
    "rev" : 41331858,
    "purchase" : 2771,
    "purchase_price" : 41331858,
    "click_total" : 58327,
    "click_multiple_urls" : 3365,
    "open_total" : 158829,
    "confirmed_opens" : 88360,
    "estopens" : 94938,
    "beacon" : 84322,
    "click" : 36113,
    "start_date" : 20150101,
    "end_date" : 20161231
}

Get Transactional Stats with URLs and Click Times

Example Call:

{
   "stat" : "send",
   "template" : "Behavioral Abandoned Cart",
   "start_date" : "2015-01-01",
   "end_date" : "2016-12-31",
   "urls" : 1,
   "click_times" : 1
}

Required Parameters

Parameter Description Example
template The name of the template to pull information from. welcome
start_date The beginning of the date range from which to pull aggregated send stats. 2012-09-30
end_date The end of the date range from which to pull aggregated send stats. 2012-10-30

Optional Parameters

Parameter Description Example
beacon_times Specify 1 to pull information about when a particular send was opened. 1
click_times Specify 1 to pull information about when links were clicked. 1
clickmap Specify 1 to pull click map information. 1
domain Specify 1 to pull information based on recipients’ email domains. 1
engagement Specify 1 to pull information based on levels of engagement. 1
list Specify this option if you want to pull send stats from one particular list. my-list
sample Specify this option to get stats on one segment of an A/B split test. A
signup Specify 1 to pull information based on signup dates. 1
urls Specify 1 to pull information based on urls. 1
Top