获取概览统计数据

Get summary statistics 获取概览统计数据

SummaryStatistics集合允许取回单元中的所有邮件总体表现数据。统计数据可能通过各种参数进行过滤和分组，如同使用在ExpertSender后台中的 “报告- >概览” 页面。

数据格式

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

可选的限制范围:

    • List 收件人列表 – 只有关于指定收件人列表的结果
    • Domain 域名 – 只有关于指定域名的结果
    • DomainFamily 域名家族 – 只有关于指定域名家族的结果*
    • MessageType 邮件类型 – 只有关于指定邮件类型的结果**
    • Ip – 只有关于指定IP的结果
    • Segment 收件人细分 – 只有关于指定收件人细分的结果
    • Vendor 收件人来源 – 只有关于指定收件人来源的结果
    • Tag 标签 – 有关于有指定标签的邮件的结果
    • SendTimeOptimization 发送时间优化 – 只有设置了特定发送时间优化方式的邮件结果***
    • TimeTravelOptimization 时区自适应 – 只有设置了特定的时区自适应优化方式的邮件结果 ****
    • ReadingEnvironment 开信环境 – 只有在特定开信环境下的结果*****
scopeValue mixed “限制范围” 参数. 如果scope被指定，那么此参数也需填写. 这是一个复杂的参数，类型取决于所选的限制范围:

    • List 收件人列表 – 收件人列表ID, int, e.g. 123
    • Domain 域名 – 域名名称, string, e.g. domain.com
    • DomainFamily 域名家族 – 域名家族名称, string, e.g. Gmail*
    • MessageType 邮件类型 – 邮件类型名称, string, e.g. Newsletter**
    • Ip – IP 通道, string, e.g. 11.22.33.44
    • Segment 收件人细分 – 收件人细分ID, int, e.g. 123
    • Vendor 收件人来源 – 收件人来源名称, string, e.g. foobar
    • Tag 标签 – 标签名称,e.g. holidays.
    • SendTimeOptimization 发送时间优化 – 只有设置了特定发送时间优化方式的邮件结果***
    • TimeTravelOptimization 时区自适应 – 有设置了特定的时区自适应优化方式的邮件结果****
    • ReadingEnvironment 开信环境 – 只有在特定开信环境下的结果 *****
grouping string “分组基于…” 参数. 选填. 如果未指定, 结果是基于整个业务单元的 (所有的数据和值将被显示于一行中).

可选的分组参数:

    • Date 日期
    • Month 月份
    • Message 邮件
    • MessageType 邮件类型
    • List 收件人列表
    • Segment 收件人细分
    • IP
    • Domain 域名
    • DomainFamily 域名家族
    • Vendor 收件人来源
    • Tag 标签
    • SendTimeOptimization 发送时间优化 – 只有设置了特定发送时间优化方式的邮件结果***
    • TimeTravelOptimization 时区自适应 – 有设置了特定的时区自适应优化方式的邮件结果****
    • ReadingEnvironment 开信环境 – 只有在特定开信环境下的结果 *****

注意: 无法使用同一类的”限制范围“和”分组基于“。”限制范围“参数值必须不同于“分组基于”参数值。
*域名家族根据业务单元有所区别，甚至可以是自定义的。通常使用的域名家族有（但不必适用于您的业务单元）：Yahoo, Outlook.com, Gmail, AOL, Other.
 
**可用的消息类型有：邮件通讯, 自动回复, 触发式邮件, 事务性邮件, 确认邮件, 定时重复发送型邮件, 测试邮件.
 
***可使用的 SendTimeOptimization（发送时间优化）邮件设置包含:  OptimizationNotUsed – 未应用发送时间优化, TimeOptimized – 应用发送时间优化的发送时间, TimeNotOptimized – 未应用发送时间优化的发送时间.
 
****可使用的TimeTravelOptimization message （时区自适应）设置包含: OptimizationNotUsed, – 未应用时区自适应, TimeOptimized – 应用时区自适应的发送时间, TimeNotOptimized – 未应用时区自适应的发送时间.
 
*****可使用的 ReadingEnvironment （开信环境）值包含: Other – 其他, Desktop – PC端, Mobile – 移动端, Webmail – 网页邮箱, NoActivity -无活动记录.

示例:

https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=YOUR_API_KEY_HEREhttps://api.esv2.com/v2/Api/SummaryStatistics?apiKey=YOUR_API_KEY_HERE&startDate=2013-12-10&endDate=2013-12-31https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=YOUR_API_KEY_HERE&scope=List&scopeValue=123https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=YOUR_API_KEY_HERE&scope=MessageType&scopeValue=Autoresponder&grouping=Date

应答

应答数据元素:
元素/属性 类型 描述
SummaryStatistics array[complex] SummaryStatistic 元素组成的数组.
SummaryStatistic 子元素:
元素/属性 类型 描述
IsSummaryRow boolean 如设为true, 将突出汇总行 (值为其他行值的总和).*
Date date 日期. 如果分组基于日期，则将被作为返回值.
Month string 月度将以日期范围形式呈现. 如果分组基于月度，则将被作为返回值.
例如: 2010-01-01 : 2010-01-31
MessageId int 邮件ID. 如果分组基于邮件，则将被作为返回值.
MessageSubject string 邮件标题. 如果分组基于邮件，则将被作为返回值.
ListId int 收件人列表ID. 如果分组基于收件人列表，则将被作为返回值.
ListName string 收件人列表名称. 如果分组基于收件人列表，则将被作为返回值.
SegmentId int 收件人细分ID. 如果分组基于收件人细分，则将被作为返回值. 且对那些未被划分到任何收件人细分中的收件人将单独划分一行，该行的返回值为”-“.
SegmentName string 收件人细分名称. 如果分组基于收件人细分，则将被作为返回值. 且对那些未被划分到任何收件人细分中的收件人将单独划分一行，该行的返回值为”-“.
Ip string IP通道地址. 如果分组基于IP，则将被作为返回值.
Domain string 域名名称. 如果分组基于域名，则将被作为返回值.
DomainFamily string 域名家族名称. 如果分组基于域名家族，则将被作为返回值.
Vendor string 收件人来源名称. 如果分组基于订阅来源，则将被作为返回值. 且对那些没有来源的收件人将单独划分一行，该行的返回值为”-“.
SendTimeOptimization string 发送时间优化. 如果分组基于发送时间优化，则将被作为返回值. 分组基于：未应用发送时间优化OptimizationNotUsed，应用发送时间优化的发送时间TimeOptimized，未应用发送时间优化的发送时间TimeNotOptimized，如都不属于以上分组将被划分为 ”-”.
TimeTravelOptimization string 时区自适应. 如果分组基于时区自适应，则将被作为返回值. 分组基于：未应用时区自适应OptimizationNotUsed，应用时区自适应的发送时间TimeOptimized，未应用时区自适应的发送时间TimeNotOptimized，如都不属于以上分组将被划分为 ”-”.
ReadingEnvironment string 开信环境. 如果分组基于开信环境，则将被作为返回值. 分组基于：其它Other, 移动端Mobile, PC端Desktop, 网页邮箱WebMail, 无活动记录NoActivity，如都不属于以上分组将被划分为 ”-”.
Sent int 已发送邮件数目.
Bounced int 退信邮件数目.
Delivered int 已送达邮件数目 (已发送减去退信).
Opens int 已打开邮件数目.
UniqueOpens int 打开邮件的收件人数目.
Clicks int 链接点击数目.
UniqueClicks int 各个链接被不同收件人第一次点击的总次数.
Clickers int 点击链接的收件人数目.
Complaints int 垃圾邮件投诉数目.
Unsubscribes int 退订链接点击数目.
Goals int 转化目标被达到的次数.
GoalsValue int 转化目标被达到的转化价值.

*汇总行并不包含“分组基于”的参数 (如. 日期, 月份).

示例

限制范围为一段时间，分组基于域名参数，建立统计数据:
请求:
GET https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=test_api_key1&startDate=2010-01-01&endDate=2012-01-01&grouping=Domain 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=209ffb47-7020-4508-99dc-8f7083928452; path=/
X-Powered-By: ASP.NET
Date: Wed, 11 Dec 2013 14:51:50 GMT
Content-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>
    <Bounced>478621</Bounced>
    <Delivered>3177803</Delivered>
    <Opens>356783</Opens>
    <UniqueOpens>243556</UniqueOpens>
    <Clicks>145664</Clicks>
    <UniqueClicks>113442</UniqueClicks>
    <Clickers>98761</Clickers>
    <Complaints>3452</Complaints>
    <Unsubscribes>34211</Unsubscribes>
    <Goals>12344</Goals>
    <GoalsValue>123440</GoalsValue>
   </SummaryStatistic>
   <SummaryStatistic>
    <Domain>yahoo.com</Domain>
    <Sent>1262372</Sent>
    <Bounced>144511</Bounced>
    <Delivered>1117861</Delivered>
    <Opens>345112</Opens>
    <UniqueOpens>245218</UniqueOpens>
    <Clicks>83445</Clicks>
    <UniqueClicks>63443</UniqueClicks>
    <Clickers>34552</Clickers>
    <Complaints>2231</Complaints>
    <Unsubscribes>56775</Unsubscribes>
    <Goals>3345</Goals>
    <GoalsValue>33450</GoalsValue>
   </SummaryStatistic>
   …
  </SummaryStatistics>
 </Data>
</ApiResponse>
限制范围为一种邮件类型，分组基于IP通道，建立统计数据:
请求:
GET https://api.esv2.com/v2/Api/SummaryStatistics?apiKey=test_api_key1&scope=MessageType&scopeValue=Newsletter&grouping=Ip 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, 11 Dec 2013 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>
    <Bounced>6136556</Bounced>
    <Delivered>15120145</Delivered>
    <Opens>198540</Opens>
    <UniqueOpens>163857</UniqueOpens>
    <Clicks>17264</Clicks>
    <UniqueClicks>15689</UniqueClicks>
    <Clickers>12326</Clickers>
    <Complaints>2106</Complaints>
    <Unsubscribes>3351</Unsubscribes>
    <Goals>0</Goals>
    <GoalsValue>0</GoalsValue>
   </SummaryStatistic>
   <SummaryStatistic>
    <Ip>11.22.33.44</Ip>
    <Sent>5051025</Sent>
    <Bounced>1814659</Bounced>
    <Delivered>3236366</Delivered>
    <Opens>45737</Opens>
    <UniqueOpens>37578</UniqueOpens>
    <Clicks>4194</Clicks>
    <UniqueClicks>3640</UniqueClicks>
    <Clickers>2887</Clickers>
    <Complaints>465</Complaints>
    <Unsubscribes>799</Unsubscribes>
    <Goals>0</Goals>
    <GoalsValue>0</GoalsValue>
   </SummaryStatistic>
   …
  </SummaryStatistics>
 </Data>
</ApiResponse>