获取收件人统计数据

Get subscriber statistics获取收件人统计数据

SmsMmsSubscriberStatistics接口可以获取指定短信/彩信收件人列表统计数据. 包含当前列表大小, 某一特定时间内列表的新增及退订用户数量等信息

请求数据格式

请求URL参数:
参数 类型 描述
apiKey string 你的API Key, 需要验证. 必填.
startDate date 起始日期. 必填. 如未指定, 默认使用业务单元的建立日期 YYYY-MM-DD 格式.
endDate date 结束日期. 必填. 如未指定, 会采用当前日期. YYYY-MM-DD 格式.
scope string “限制范围”. 选填. 没有任何限制将被应用 (整个业务单元的数据将被返回).
可选的限制范围:

    • List – 收件人列表, 只有关于指定收件人列表的结果
    • SmsMmsMessageType – 消息类型, 只有关于指定短信/彩信消息类型的结果*
    • Vendor – 收件人来源, 只有关于指定收件人来源的结果
    • Tag – 标签, 只有关于有指定标签的邮件的结果
scopeValue string “限制范围” 参数. 如果scope被指定，那么此参数也需填写. 这是一个复杂的参数，类型取决于所选的限制范围

    • List – 列表ID, 整型, 如: 123
    • SmsMmsMessageType – 短信/彩信类型名称, 字符串, 如: Newsletter*
    • Vendor – 消息来源名称, 字符串, 如: foobar
    • Tag – 标签名称, 如: holidays
scope2 string “scope2” – 和”scope”一致.
scopeValue2 string “限制范围” scope2参数.
grouping string “分组基于…” 参数. 选填. 如果未指定, 结果是基于整个业务单元的 (所有的数据和值将被显示于一行中). 可选的分组参数:

    • Date
    • Month
    • List
    • Vendor
    • Tag

注意: 限制范围和分组参数不能是同一范畴。scope参数取值必须与grouping的参数不同.
*可选消息类型: Newsletter, 测试消息, 工作流消息.

示例

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

应答

请求数据元素:
元素/属性 类型 描述
SubscriberStatistics array[complex] SubscriberStatistic元素组成的数组
SubscriberStatistic子元素:
元素/属性 类型 描述
IsSummaryRow boolean 如设为true, 将突出汇总行 (值为其他行值的总和).*
Date date 日期. 只在分组基于日期请求时返回.
Month string 月份以日期区间形式显示. 只在分组基于月份请求时返回.如: 2018-01-01 : 2018-01-31
ListId int 收件人列表ID. 只在分组基于列表ID请求时返回.
ListName string 收件人列表名称. 只在分组基于收件人列表名称请求时返回.
Vendor string 收件人来源名称. 只在分组基于收件人来源请求时返回. 且对那些没有来源的收件人将单独划分一行，该行的返回值为”-“.
Tag string 标签名称. 只在分组基于标签请求时返回.
ListSize int 当前列表大小
Growth int 列表大小增/减
Added int 添加到列表的收件人总计
AddedUi int 通过ExpertSender平台添加到列表收件人数量
AddedImport int 通过自动导入添加到收件人列表数量
AddedApi int 通过API接口添加到收件人列表数量
AddedWeb int 通过网页表单添加到收件人列表数量
AddedSms int 通过SMS添加到收件人列表数量
Removed int 从列表中删除的收件人数量
RemovedOptOut int 因点击退订链接删除的收件人数量
RemovedUser int 通过平台手动删除的收件人数量
RemovedBounceLimit int 因达到最大弹回次数删除的收件人数量
RemovedSpam int 举报垃圾消息删除的收件人数量
RemovedUserUnknown int 因无效邮箱删除的收件人数量
RemovedBlacklist int 因被添加到黑名单删除的收件人数量
RemovedApi int 通过API接口删除的收件人数量
*不包含分组的列(如：日期, 月份).

示例

请求(未分组的统计数据):
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应答:
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>