Request various stats from Sailthru.
https://api.sailthru.com/stats
GET mode is always used for this API call. One parameter is always required:
| Parameter | Description | Example |
|---|---|---|
stat | What type of stat you wish to request | list |
The different type of stats are covered below.
Retrieve information about your subscriber counts on a particular list, on a particular day.
Please note that subscriber counts are only tracked for primary lists. Make sure your lists are primary if you plan on using this call. For more on this, see the documentation on lists.
| 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) | 2010-09-29 |
A structure containing any or all of the following:
| Field | Description | Example |
|---|---|---|
list | The name of the list, or an empty string if retrieving all subscribers | my-list |
day | The day the count was made (generally around midnight) | 20100929 |
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 |
active_count | The number of passive users | 41772 |
passive_count | The number of passive users | 68583 |
dormant_count | The number of dormant users | 189760 |
hardbounce_count | The number of users who are hardbounces | 4423 |
optout_count | The number of users who are optouts | 81931 |
lists_count | The total number of subscriptions by all members of this list | 2196518 |
lists_signup_count | The number of users who joined this list in the past 24 hours | 7683 |
optout_loss_count | The number of users who opted out in the past 24 hours | 81931 |
lists_remove_count | The number of users who were removed from this list in the past 24 hours | 0 |
Retrieve information about a particular blast or aggregated information from all of blasts over a specified date range.
Must specify either a blast_id or a start_date and end_date.
For more on this, see the documentation on blast.
| Parameter | Description | Example |
|---|---|---|
blast_id | The id of the blast to pull information from. Required if start_date and end_date are not specified. | 123456 |
start_date | The beginning of the date range from which to pull aggregated blast stats. Required if blast_id is not specified. | 2010-09-29 |
end_date | The beginning of the date range from which to pull aggregated blast stats. Required if blast_id is not specified. | 2011-01-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 |
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 |
Retrieve information about a particular send or aggregated information from all of sends over a specified date range.
Must specify either a template or a start_date and end_date.
For more on this, see the documentation on send.
| Parameter | Description | Example |
|---|---|---|
template | The name of the template to pull information from. Required if start_date and end_date are not specified. | 123456 |
start_date | The beginning of the date range from which to pull aggregated send stats. Required if template is not specified. | 2010-09-29 |
end_date | The beginning of the date range from which to pull aggregated send stats. Required if template is not specified. | 2011-01-29 |
list | Specify this option if you want to pull send stats from one particular list. | my-list |
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 |
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 |