获取导入统计数据

Get import reports 获取导入统计数据

ImportReports 接口允许检索关于导入到收件人列表，禁止列表，黑名单以及数据表格的表现数据。

请求数据格式

请求URL参数：
参数 类型 描述
apiKey string 您的API Key,为了认证身份.必填.
reportType string 必填参数. 返回的数据类型.支持统计的类型有：收件人列表Subscribers、禁止列表Suppressions、黑名单Blacklist和数据表格DataTables.
startDate date 起始日期. 选填. 两个参数 (startDate, endDate) 以确定获得数据的具体时间范围。如果不填写，将被忽略。YYYY-MM-DD 格式.
endDate date 见 startDate.
scheduledTaskId int 选填.导入任务所从属的预设排期标识ID.
listId int 选填.导入目标收件人列表ID. 注意reportType= Subscribers. 否则会被忽略.
suppressionListId int 选填. 导入目标禁止列表ID. 注意reportType=Suppressions. 否则会被忽略.
示例:
https://api.esv2.com/v2/Api/ImportReports?ReportType=Suppressions&apiKey=YOUR_API_KEY_HERE&StartDate=2017-10-27https://api.esv2.com/v2/Api/ImportReports?ReportType=Subscribers&apiKey=YOUR_API_KEY_HERE&ScheduledTaskID=3344&StartDate=2017-10-26&EndDate=2017-10-28&ListId=7459

应答

应答数据元素:
元素/属性 类型 描述
ImportReports array[complex] ImportReport元素组成的数组.
ImportReport子元素:
元素/属性 类型 描述
Id int 导入任务的标识ID.
FileName string 导入数据源的文件名
ImportDate date 导入任务执行的日期
ListId int 收件人列表ID或者禁止列表ID.
ListName string 收件人列表或者禁止列表名称.
ImportType string 导入设置的选项
MatchingMode string 导入所选择的映射列.
ScheduledTaskId int 导入任务所从属的预设排期
TotalRows int 导入文件中的总条目数
ValidRows int 导入文件中的有效条目数
InvalidRows int 导入文件中的无效条目数
ConflictingRecords int 与现有收件人冲突的记录数
DuplicatedRows int 导入文件中的重复条目数
Entries complex 基于映射列所发现的统计条目.
Subscriptions complex 基于通道所发现的收件人订阅详情.
Status string 任务完成状态.
ErrorDescription string 数据表格错误描述.

条目元素:

元素/属性 类型 描述
Email complex Email秘钥导入详细统计数据.
Phone complex 电话号码秘钥导入详细统计数据.
CustomSubscriberId complex 收件人标识ID秘钥导入详细统计数据.

Email/电话号码/收件人识别ID 子元素:

元素/属性 类型 描述
Valid int 有效条目数量.
Invalid int 无效条目数量.
Duplicated int 重复条目数量.
Empty int 空条目数量.
订阅元素:
元素/属性 类型 描述
Email complex Email通道订阅详细统计数据.
Phone complex Phone通道订阅详细统计数据.
订阅子元素:
元素/属性 类型 描述
Added int 添加的条目数量.
Updated int 更新的条目数量.
Replaced int 替换的条目数量.
SystemRejected int 系统拒绝的条目数量.
Blacklisted int 在黑名单上的条目数量.
Unsubscribed int 退订数量.

示例

数据表格导入请求:
GET https://api.esv2.com/v2/Api/ImportReports?ReportType=DataTables&apiKey= YOUR_API_KEY_HERE&StartDate=2017-10-31 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 
Content-Encoding: gzip 
Vary: Accept-Encoding 
Server: Microsoft-IIS/7.5 
Set-Cookie: ASP.NET_SessionId=znbbf255rwgtzketrup04q55; path=/; HttpOnly 
X-AspNetMvc-Version: 5.2
X-AspNet-Version: 4.0.30319 
X-Powered-By: ASP.NET 
Date: Fri, 31 Oct 2014 11:05:25 GMT 
Content-Length: 651 
 

<ApiResponse
xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
 <Data>
  <ImportReports>
   <ImportReport>
            <Id>137</Id>
            <FileName>test_importu.csv</FileName>
            <ImportDate>2014-10-31T07:21:33</ImportDate>
       <ImportType>Synchronize table with import file</ImportType>
            <ScheduledTaskId>3347</ScheduledTaskId>
            <AddedEntries>0</AddedEntries>
            <Status>Error</Status>
            <ErrorDescription>Nie ma tabeli o podanej nazwie pliku: test_importu.csv</ErrorDescription>
         </ImportReport>
  </ImportReports>
   </Data>
</ApiResponse>
收件人导入请求:
GET https://api.esv2.com/v2/Api/ImportReports?ReportType=Subscribers&apiKey= YOUR_API_KEY_HERE&StartDate=2017-10-31 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 
Content-Encoding: gzip 
Vary: Accept-Encoding 
Server: Microsoft-IIS/7.5 
Set-Cookie: ASP.NET_SessionId=znbbf255rwgtzketrup04q55; path=/; HttpOnly 
X-AspNetMvc-Version: 5.2
X-AspNet-Version: 4.0.30319 
X-Powered-By: ASP.NET 
Date: Fri, 31 Oct 2014 11:05:25 GMT 
Content-Length: 651<ApiResponse
xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
 <Data>
  <ImportReports>
   <ImportReport>
    <Id>125</Id>
    <FileName>test_importu.csv</FileName>
    <ImportDate>2017-11-10T07:21:33</ImportDate>
    <ListId>29</ListId>       
    <ListName>List_123</ListName>
    <ImportType>Add new subscribers and update data of subscribers existing on the list</ImportType>
    <MatchingMode>Email</MatchingMode>
    <TotalRows>41</TotalRows>
    <ValidRows>34</ValidRows>
    <InvalidRows>3</InvalidRows>
    <ConflictingRecords>4</ConflictingRecords>
    <DuplicatedRows>0</DuplicatedRows>
    ;<Entries>
     <Email>
      <Valid>38</Valid>
      <Duplicated>0</Duplicated>
      <Invalid>3</Invalid>
      <Empty>0</Empty>
     </Email>
     <Phone>
      <Valid>41</Valid>
      <Duplicated>0</Duplicated>
      <Invalid>0</Invalid>
      <Empty>0</Empty>
     </Phone>
     <CustomSubscriberId>
      <Valid>0</Valid>
      <Duplicated>0</Duplicated>
      <Invalid>0</Invalid>
      <Empty>0</Empty>
     </CustomSubscriberId>
    </Entries>
    <Subscriptions>
     <Email>
      <Added>4</Added>
      <Updated>33</Updated>
      <Replaced>0</Replaced>
      <SystemRejected>0</SystemRejected>
      <Blacklisted>1</Blacklisted>
      <Unsubscribed>0</Unsubscribed>
     </Email>
     <Phone>
      <Added>35</Added>
      <Updated>0</Updated>
      <Replaced>0</Replaced>
      <SystemRejected>1</SystemRejected>
      <Blacklisted>5</Blacklisted>
      <Unsubscribed>0</Unsubscribed>
     </Phone>   
    </Subscriptions>
   </ImportReport>
  </ImportReports>
 </Data>
</ApiResponse>