Skip to content

Get subscriber statistics

SmsMmsSubscriberStatistics collection allows retrieving data about performance of subscriber lists. This means current list size, number of subscribers that subscribed to or unsubscribed from the list in specified time period and so on.

Request data format

Request URL parameters:

Element/attributeTypeNotes
apiKeystringYour API key, required for authentication. Required.
startDatedate Start date. Optional. If not specified, business unit creation date will be taken. YYYY-MM-DD format.
endDatedateEnd date. Optional. If not specified, current date will be taken. YYYY-MM-DD format.
scopestringFiltering scope. Optional. If not specified, no filtering will be applied (data for the whole business unit will be returned).

Available scopes are:
List – only results for specific subscriber listSmsMmsMessageType – only results for specific SMS/MMS message type*Vendor – only results for specific vendorTag – only results for messages marked with a tag
scopeValuestringFiltering scope value. Required if scope was specified. This is a mixed value, type depends on selected scope.
List – List ID, int, e.g. 123SmsMmsMessageType – SMS/MMS message type name, string, e.g. Newsletter*Vendor – vendor name, string, e.g. foobarTag – Tag name, e.g. holidays
scope2stringSecond filtering scope – works just like “scope”.
scopeValue2stringFiltering scope value for “scope2”.
groupingstringResults grouping. Optional. If not specified, results will be grouped by whole business unit (one row of data will be returned with all values summed up).
 
Available groupings are:
DateMonthListVendorTagNOTE: It is impossible to filter and group by the same thing. scope parameter value must be different from grouping parameter value

*Available message types: Newsletter, Test, WorkflowMessage.

Examples:

https://api.esv2.com/v2/Api/SmsMmsSubscriberStatistics?apiKey=YOUR_API_KEY_HERE

https://api.esv2.com/v2/Api/SmsMmsSubscriberStatistics?apiKey=YOUR_API_KEY_HERE&scope=List&scopeValue=1&grouping=Vendor

Response

Response Data element:

Element/attributeTypeNotes
SubscriberStatisticsarray[complex]Array of SubscriberStatistic elements.

SubscriberStatistic element children:

Element/attributeTypeNotes
IsSummaryRowbooleanIf set to true, marks the summary row of statistic table (values are sums of all other rows).*
DatedateDate. Returned only if grouping by dates was requested.
MonthstringMonth represented as date period. Returned only if grouping by months was requested.
Example: 2018-01-01 : 2018-01-31
ListIdintSubscriber list ID. Returned only if grouping by lists was requested.
ListNamestringSubscriber list name. Returned only if grouping by lists was requested.
VendorstringVendor name. Returned only if grouping by vendors was requested. If row contains data about subscribers with no vendor, dash (“-“) will be returned.
TagstringTag name. Returned only if grouping by tags was requested.
ListSizeintCurrent list size.
GrowthintList size increase/decrease.
Addedint Overall number of subscribers that were added to the list.
AddedUiintNumber of subscribers added manually using ExpertSender web panel.
AddedImportintNumber of subscribers added using manual or automatic imports.
AddedApiintNumber of subscribers added using API.
AddedWebintNumber of subscribers added using webforms.
AddedSmsintNumber of subscribers added using SMS.
RemovedintOverall number of subscribers removed from the list.
RemovedOptOutintNumber of subscribers removed because they clicked unsubscribe link.
RemovedUserintNumber of subscribers removed manually using web panel.
RemovedBounceLimitintNumber of subscribers removed because they reached the maximum number of bounces.
RemovedSpamintNumber of subscribers removed because they sent a spam complaint.
RemovedUserUnknownintNumber of subscribers removed because their email address bounced with “User Unknown” status.
RemovedBlacklistintNumber of subscribers removed because they were added to blacklist.
RemovedApiintNumber of subscribers removed using API.

*Summary rows do not contain grouping columns (e.g. Date, Month).

Examples

Request (ungrouped statistics):

GET https://api.esv2.com/v2/Api/SmsMmsSubscriberStatistics?apiKey=test_api_key1&scope=List&scopeValue=1&scope2=SmsMmsMessageType&scopeValue2=Newsletter HTTP/1.1
Accept-Encoding: gzip,deflate
Host: api.esv2.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

OK response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 5.2
X-AspNet-Version: 4.0.30319
Set-Cookie: TEMP_DATA=b8567a11-cbb2-4525-b355-782b8b3ea005; path=/
X-Powered-By: ASP.NET
Date: Wed, 29 Jul 2015 14:44:34 GMT
Content-Length: 870

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <SubscriberStatistics>
      <SubscriberStatistic>
        <IsSummaryRow>true</IsSummaryRow>
        <ListSize>469</ListSize>
        <Growth>469</Growth>
        <Added>470</Added>
        <AddedUi>0</AddedUi>
        <AddedImport>437</AddedImport>
        <AddedApi>0</AddedApi>
        <AddedWeb>0</AddedWeb>
        <AddedSms>0</AddedSms>
        <Removed>1</Removed>
        <RemovedOptOut>1</RemovedOptOut>
        <RemovedUser>0</RemovedUser>
        <RemovedBounceLimit>0</RemovedBounceLimit>
        <RemovedSpam>0</RemovedSpam>
        <RemovedUserUnknown>0</RemovedUserUnknown>
        <RemovedBlacklist>0</RemovedBlacklist>
        <RemovedApi>0</RemovedApi>
      </SubscriberStatistic>
    </SubscriberStatistics>
  </Data>
</ApiResponse>
On this page
To top