List.GetStats

This is an older version of the Campaign Monitor API. We strongly encourage you to quit livin' in the past and use the shiny new RESTful version with lots of new functionality. You won't regret it.

Gets statistics for a subscriber list

Parameters and required information
Return Codes
SOAP 1.1
HTTP GET
HTTP POST

Parameters and required information

Here’s a list of all the parameters you’ll need to pass to the List.GetStats method. All of the parameters are required unless otherwise noted.

ApiKey
Your API key. See here for more details.

ListID
The ID of the list whose statistics will be returned. See here for more details.

Return Codes

Success

A successful call to List.GetStats will return a ListStatistics object, consisting of TotalActiveSubscribers, NewActiveSubscribersToday, NewActiveSubscribersYesterday, NewActiveSubscribersThisWeek, NewActiveSubscribersThisMonth, NewActiveSubscribersThisYear, TotalUnsubscribes, UnsubscribesToday, UnsubscribesYesterday, UnsubscribesThisWeek, UnsubscribesThisMonth, UnsubscribesThisYear, TotalDeleted, DeletedToday, DeletedYesterday, DeletedThisWeek, DeletedThisMonth, DeletedThisYear, TotalBounces, BouncesToday, BouncesYesterday, BouncesThisWeek, BouncesThisMonth and BouncesThisYear.

Error

100: Invalid API Key
The API key passed in was not valid or has expired.

101: Invalid ListID
The ListID value passed in was not valid.

SOAP 1.1

The following is a sample SOAP request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx HTTP/1.1
Host: api.createsend.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.createsend.com/api/List.GetStats"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <List.GetStats xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ListID>string</ListID>
    </List.GetStats>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <List.GetStatsResponse xmlns="http://api.createsend.com/api/">
      <List.GetStatsResult>
        <TotalActiveSubscribers>int</TotalActiveSubscribers>
        <NewActiveSubscribersToday>int</NewActiveSubscribersToday>
        <NewActiveSubscribersYesterday>int</NewActiveSubscribersYesterday>
        <NewActiveSubscribersThisWeek>int</NewActiveSubscribersThisWeek>
        <NewActiveSubscribersThisMonth>int</NewActiveSubscribersThisMonth>
        <NewActiveSubscribersThisYear>int</NewActiveSubscribersThisYear>
        <TotalUnsubscribes>int</TotalUnsubscribes>
        <UnsubscribesToday>int</UnsubscribesToday>
        <UnsubscribesYesterday>int</UnsubscribesYesterday>
        <UnsubscribesThisWeek>int</UnsubscribesThisWeek>
        <UnsubscribesThisMonth>int</UnsubscribesThisMonth>
        <UnsubscribesThisYear>int</UnsubscribesThisYear>
        <TotalDeleted>int</TotalDeleted>
        <DeletedToday>int</DeletedToday>
        <DeletedYesterday>int</DeletedYesterday>
        <DeletedThisWeek>int</DeletedThisWeek>
        <DeletedThisMonth>int</DeletedThisMonth>
        <DeletedThisYear>int</DeletedThisYear>
        <TotalBounced>int</TotalBounced>
        <BouncedToday>int</BouncedToday>
        <BouncedYesterday>int</BouncedYesterday>
        <BouncedThisWeek>int</BouncedThisWeek>
        <BouncedThisMonth>int</BouncedThisMonth>
        <BouncedThisYear>int</BouncedThisYear>
      </List.GetStatsResult>
    </List.GetStatsResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /api/api.asmx/List.GetStats?ApiKey=string&ListID=string HTTP/1.1
Host: api.createsend.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ListStatistics xmlns="http://api.createsend.com/api/" />
  <TotalActiveSubscribers>int</TotalActiveSubscribers>
  <NewActiveSubscribersToday>int</NewActiveSubscribersToday>
  <NewActiveSubscribersYesterday>int</NewActiveSubscribersYesterday>
  <NewActiveSubscribersThisWeek>int</NewActiveSubscribersThisWeek>
  <NewActiveSubscribersThisMonth>int</NewActiveSubscribersThisMonth>
  <NewActiveSubscribersThisYear>int</NewActiveSubscribersThisYear>
  <TotalUnsubscribes>int</TotalUnsubscribes>
  <UnsubscribesToday>int</UnsubscribesToday>
  <UnsubscribesYesterday>int</UnsubscribesYesterday>
  <UnsubscribesThisWeek>int</UnsubscribesThisWeek>
  <UnsubscribesThisMonth>int</UnsubscribesThisMonth>
  <UnsubscribesThisYear>int</UnsubscribesThisYear>
  <TotalDeleted>int</TotalDeleted>
  <DeletedToday>int</DeletedToday>
  <DeletedYesterday>int</DeletedYesterday>
  <DeletedThisWeek>int</DeletedThisWeek>
  <DeletedThisMonth>int</DeletedThisMonth>
  <DeletedThisYear>int</DeletedThisYear>
  <TotalBounced>int</TotalBounced>
  <BouncedToday>int</BouncedToday>
  <BouncedYesterday>int</BouncedYesterday>
  <BouncedThisWeek>int</BouncedThisWeek>
  <BouncedThisMonth>int</BouncedThisMonth>
  <BouncedThisYear>int</BouncedThisYear>
</ListStatistics>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx/List.GetStats HTTP/1.1
Host: api.createsend.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ApiKey=string&ListID=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ListStatistics xmlns="http://api.createsend.com/api/" />
  <TotalActiveSubscribers>int</TotalActiveSubscribers>
  <NewActiveSubscribersToday>int</NewActiveSubscribersToday>
  <NewActiveSubscribersYesterday>int</NewActiveSubscribersYesterday>
  <NewActiveSubscribersThisWeek>int</NewActiveSubscribersThisWeek>
  <NewActiveSubscribersThisMonth>int</NewActiveSubscribersThisMonth>
  <NewActiveSubscribersThisYear>int</NewActiveSubscribersThisYear>
  <TotalUnsubscribes>int</TotalUnsubscribes>
  <UnsubscribesToday>int</UnsubscribesToday>
  <UnsubscribesYesterday>int</UnsubscribesYesterday>
  <UnsubscribesThisWeek>int</UnsubscribesThisWeek>
  <UnsubscribesThisMonth>int</UnsubscribesThisMonth>
  <UnsubscribesThisYear>int</UnsubscribesThisYear>
  <TotalDeleted>int</TotalDeleted>
  <DeletedToday>int</DeletedToday>
  <DeletedYesterday>int</DeletedYesterday>
  <DeletedThisWeek>int</DeletedThisWeek>
  <DeletedThisMonth>int</DeletedThisMonth>
  <DeletedThisYear>int</DeletedThisYear>
  <TotalBounced>int</TotalBounced>
  <BouncedToday>int</BouncedToday>
  <BouncedYesterday>int</BouncedYesterday>
  <BouncedThisWeek>int</BouncedThisWeek>
  <BouncedThisMonth>int</BouncedThisMonth>
  <BouncedThisYear>int</BouncedThisYear>
</ListStatistics>

API Documentation