获取概览统计数据

Get Summary Statistics 获取概览统计数据

SmsMmsSummaryStatistics可调用短信/彩信发送效果概览数据统计。数据统计可能通过各种参数进行分组查看，如同使用在ExpertSender后台中的 “报告- >概览” 页面

请求数据格式

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

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

    • List – 列表ID, 整型, e.g. 123
    • Segment – 收件人细分ID, 整型, e.g. 123
    • SmsMmsMessageType – 消息类型名称, 字符串型, e.g. Newsletter*
    • Vendor – vendor名称, 字符串型, e.g. foobar
    • Tag – 标签名称, 字符串型, e.g. holidays
    • MobileOS – 手机操作系统名称, 字符串型, e.g. Android
    • Sender – 发送方名称, 字符串型, e.g. smsApi
grouping string “分组基于…” 参数. 选填. 如果未指定, 结果是基于整个业务单元的 (所有的数据和值将被显示于一行中). 可选的分组参数:

    • Date – 日期
    • Month – 月份
    • SmsMmsMessage – 短信/彩信消息
    • SmsMmsMessageType – 短信/彩信消息类型
    • List – 收件人列表
    • Segment – 收件人细分
    • Vendor – 收件人来源
    • Tag – 标签
    • MobileOS – 手机操作系统
    • Sender – 发送方

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

示例:

https://api.esv2.com/v2/Api/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HEREhttps://api.esv2.com/v2/Api/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE&startDate=2017-12-10&endDate=2017-12-31https://api.esv2.com/v2/Api/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE&scope=List&scopeValue=123https://api.esv2.com/v2/Api/SmsMmsSummaryStatistics?apiKey=YOUR_API_KEY_HERE&scope=SmsMmsMessageType&scopeValue=WorkflowMessage&grouping=Date

应答

应答Data元素:
元素/属性 类型 描述
SummaryStatistics array[complex] SummaryStatistics元素组成的数组.
SummaryStatistic子元素:
元素/属性 类型 描述
IsSummaryRow boolean 如设为true, 将突出汇总行 (值为其他行值的总和).*
Date date 日期. 只在分组基于日期请求时返回.
Month string 月份以日期区间形式显示. 只在分组基于月份请求时返回.
如: 2018-01-01 : 2018-01-31
SmsMmsMessageId int 消息ID. 只在分组基于短信/彩信消息请求时返回.
Campaign string Campaign名称. 只在分组基于Campaign名称请求时返回.
SmsMmsMessageType string 消息类型名称. 只在分组基于消息类型请求时返回.
ListId int 收件人列表ID. 只在分组基于列表ID请求时返回.
ListName string 收件人列表名称. 只在分组基于收件人列表名称请求时返回.
SegmentId int 收件人细分ID. 只在分组基于收件人细分ID请求时返回.
SegmentName string 收件人细分名称. 只在分组基于收件人细分名称请求时返回. 且对那些未被划分到任何收件人细分中的收件人将单独划分一行，该行的返回值为”-“.
Vendor string 收件人来源名称. 只在分组基于收件人来源请求时返回. 且对那些没有来源的收件人将单独划分一行，该行的返回值为”-“.
Tag string 标签名称. 只在分组基于标签请求时返回.
MobileOS string 手机操作系统名称. 只在分组基于操作系统请求时返回.
Sender string 发送方. 只在分组基于发送方请求时返回.
Sent int 已发送消息数量.
PartsSent int 已发送消息部分数量.
Bounced int 弹回消息数量.
Delivered int 已送达消息数量 (发送 – 弹回).
Clicks int 链接点击数量.
Clickers int 独立点击任意链接的收件人数量.
Unsubscribes int 退订链接点击数量.
Goals int 所达到的转化数量.
GoalsValue int 所达到的转化值.
* 不包含分组的列(e.g. 日期, 月份).

示例

按列表进行划分的时间区间数据统计
请求
GET https://api.esv2.com/v2/Api/SmsMmsSummaryStatistics?apiKey=test_api_key1&startDate=2018-01-01&endDate=2018-01-30&grouping=List HTTP/1.1
Accept-Encoding: gzip,deflate
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
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.0
X-AspNet-Version: 4.0.30319Set-Cookie: TEMP_DATA=209ffb47-7020-4508-99dc-8f7083928452; path=/X-Powered-By: ASP.NETDate: Wed, 21 Feb 2018 14:51:50 GMTContent-Length: 97229

<ApiResponse xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
 <Data>
  <SummaryStatistics>
   <SummaryStatistic>
    <IsSummaryRow>true</IsSummaryRow>
    <Sent>3656424</Sent>
    <PartsSent>7334910</PartsSent>
    <Bounced>478621</Bounced>
    <Delivered>3177803</Delivered>
    <Clicks>145664</Clicks>
    <Clickers>98761</Clickers>
    <Unsubscribes>34211</Unsubscribes>
    <Goals>12344</Goals>
    <GoalsValue>123440</GoalsValue>
   </SummaryStatistic>
   <SummaryStatistic>
    <ListId>38</ListId>
    <ListName>test list</ListName>
    <Sent>1262372</Sent>
    <PartsSent>1490223</PartsSent>
    <Bounced>144511</Bounced>
    <Delivered>1117861</Delivered>
    <Clicks>83445</Clicks>
    <Clickers>34552</Clickers>
    <Unsubscribes>56775</Unsubscribes>
    <Goals>3345</Goals>
    <GoalsValue>33450</GoalsValue>
   </SummaryStatistic>
   …
  </SummaryStatistics>
 </Data>
</ApiResponse>
按消息类型和月份方式进行划分的数据统计
请求:
GET https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=test_api_key1&scope=SmsMmsMessageType&scopeValue=Newsletter&grouping=Month HTTP/1.1
Accept-Encoding: gzip,deflate
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
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.0
X-AspNet-Version: 4.0.30319
Set-Cookie: TEMP_DATA=90015733-b2c3-4a23-93ac-b9bce60ab8af; path=/
X-Powered-By: ASP.NET
Date: Wed, 21 Feb 2018 15:04:03 GMT
Content-Length: 5655

<ApiResponse xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
  <Data>
    <SummaryStatistics>
      <SummaryStatistic>
        <IsSummaryRow>true</IsSummaryRow>
        <Sent>21256701</Sent>
        <PartsSent>32721341</PartsSent>
        <Bounced>6136556</Bounced>
        <Delivered>15120145</Delivered>
        <Clicks>17264</Clicks>
        <Clickers>12326</Clickers>
        <Unsubscribes>3351</Unsubscribes>
        <Goals>0</Goals>
        <GoalsValue>0</GoalsValue>
      </SummaryStatistic>
      <SummaryStatistic>
        <Month>2018-01-01 : 2018-01-31</Month>
        <Sent>5051025</Sent>
        <PartsSent>6725568</PartsSent>
        <Bounced>1814659</Bounced>
        <Delivered>3236366</Delivered>
        <Clicks>4194</Clicks>
        <Clickers>2887</Clickers>
        <Unsubscribes>799</Unsubscribes>
        <Goals>0</Goals>
        <GoalsValue>0</GoalsValue>
      </SummaryStatistic>
      …
    </SummaryStatistics>
  </Data>
</ApiResponse>