{"id":10935,"date":"2024-06-25T11:11:36","date_gmt":"2024-06-25T10:11:36","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=10935"},"modified":"2024-06-25T12:21:02","modified_gmt":"2024-06-25T11:21:02","slug":"get-import-reports","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/get-import-reports\/","title":{"rendered":"Get import reports"},"content":{"rendered":"\n

ImportReports collection allows retrieving information about imports to subscribers list, suppressions list, blacklist or data tables.<\/p>\n\n\n\n

Request data format<\/strong><\/h3>\n\n\n\n

Request URL parameters:<\/p>\n\n\n\n

Parameter<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
reportType<\/td>string<\/td>Required parameter. Type of data to retrieve. Supported report types are: Subscribers, Suppressions, Blacklist, DataTables.<\/td><\/tr>
startDate<\/td>date<\/td>Start date. Optional. Both parameters (startDate, endDate) are required to specify report range. Otherwise they are ignored. YYYY-MM-DD format.<\/td><\/tr>
endDate<\/td>date<\/td>See startDate.<\/td><\/tr>
scheduledTaskId<\/td>int<\/td>Optional. Scheduled Task which launched import.<\/td><\/tr>
listId<\/td>int<\/td>Optional. Subscriber list ID where was import targeted. Taken with reportType = Subscribers. Otherwise ignored.<\/td><\/tr>
suppressionListId<\/td>int<\/td>Optional. Suppression list ID where was import targeted. Taken with reportType = Suppressions. Otherwise ignored.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Example:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/ImportReports?ReportType=Suppressions&apiKey=YOUR_API_KEY_HERE&StartDate=2017-10-27<\/span><\/span>\nhttps:\/\/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<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/h3>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
ImportReports<\/td>array[complex]<\/td>Array of ImportReports elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
ImportReport element children:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Id<\/td>int<\/td>Import identifier.<\/td><\/tr>
FileName<\/td>string<\/td>Name of file used for import source.<\/td><\/tr>
ImportDate<\/td>date<\/td>Date of import execution.<\/td><\/tr>
FinishedDate<\/td>date<\/td>Date of import finished execution(only for subscriber and data table imports).<\/td><\/tr>
ListId<\/td>int<\/td>Subscribers or suppressions list ID.<\/td><\/tr>
ListName<\/td>string<\/td>Subscribers or suppressions list name.<\/td><\/tr>
ImportType<\/td>string<\/td>Selected import mode.<\/td><\/tr>
MatchingMode<\/td>string<\/td>Selected import key.<\/td><\/tr>
ScheduledTaskId<\/td>int\u00a0<\/td>Scheduled task which launched import.<\/td><\/tr>
TotalRows<\/td>int\u00a0<\/td>Total\u00a0number of rows found in import file.<\/td><\/tr>
ValidRows<\/td>int\u00a0<\/td>Number of valid rows found in import file.<\/td><\/tr>
InvalidRows<\/td>int\u00a0<\/td>Number of invalid rows found in import file.<\/td><\/tr>
ConflictingRecords<\/td>int\u00a0<\/td>Number of conflicts with existing subscribers.<\/td><\/tr>
DuplicatedRows<\/td>int\u00a0<\/td>Number of duplicated rows found in import file.\u00a0<\/td><\/tr>
Entries<\/td>complex
<\/td>		Entries element containing statistics grouped by import key type.<\/td><\/tr>
Subscriptions<\/td>complex
<\/td>		Subscriptions element containing detailed statistics grouped by channel.<\/td><\/tr>
Status<\/td>string<\/td>Task completion status.<\/td><\/tr>
ErrorDescription<\/td>string<\/td>Description of data table error if occurs.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Entries element:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Email<\/td>complex<\/td>Detailed statistics for Email import key.<\/td><\/tr>
Phone<\/td>complex<\/td>Detailed statistics for Phone import key.<\/td><\/tr>
CustomSubscriberId<\/td>complex<\/td>Detailed statistics for CustomSubscriberId import key.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Email\/Phone\/CustomSubscriberId elements’ children:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Valid<\/td>int<\/td>Number of valid entries found.<\/td><\/tr>
Invalid<\/td>int<\/td>Number of invalid entries found.<\/td><\/tr>
Duplicated<\/td>int<\/td>Number of duplicated entries found.<\/td><\/tr>
Empty<\/td>int<\/td>Number of empty entries found.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Subscriptions element:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Email<\/td>complex<\/td>Detailed subscription statistics for Email channel.<\/td><\/tr>
Phone<\/td>complex<\/td>Detailed subscription statistics for Phone channel.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Subscriptions’ element children:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Added<\/td>int<\/td>Number of added entries.<\/td><\/tr>
Updated<\/td>int<\/td>Number of updated entries.<\/td><\/tr>
Replaced<\/td>int<\/td>Number of replaced entries.<\/td><\/tr>
SystemRejected<\/td>int<\/td>Number of entries rejected by the system.<\/td><\/tr>
Blacklisted<\/td>int<\/td>Number of blacklisted entries.<\/td><\/tr>
Unsubscribed<\/td>int<\/td>Number of unsubscriptions.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Example<\/strong><\/h3>\n\n\n\n
DataTables import<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET <\/span><\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/ImportReports?ReportType=DataTables&apiKey= YOUR_API_KEY_HERE&StartDate=2017-10-31 HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nContent-Encoding: gzip <\/span><\/span>\nVary: Accept-Encoding <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nSet-Cookie: ASP.NET_SessionId=znbbf255rwgtzketrup04q55; path=\/; HttpOnly <\/span><\/span>\nX-AspNetMvc-Version: 5.2<\/span><\/span>\nX-AspNet-Version: 4.0.30319 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Fri, 31 Oct 2014 11:05:25 GMT <\/span><\/span>\nContent-Length: 651 <\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span>><\/span><\/span>\n    <\/span><<\/span>ImportReports<\/span>><\/span><\/span>\n      <\/span><<\/span>ImportReport<\/span>><\/span><\/span>\n        <\/span><<\/span>Id<\/span>><\/span>137<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n        <\/span><<\/span>FileName<\/span>><\/span>test_importu.csv<\/span><\/<\/span>FileName<\/span>><\/span><\/span>\n        <\/span><<\/span>ImportDate<\/span>><\/span>2014-10-31T07:21:33<\/span><\/<\/span>ImportDate<\/span>><\/span><\/span>\n        <\/span><<\/span>FinishedDate<\/span>><\/span>2014-10-31T07:35:26.283<\/span><\/<\/span>FinishedDate<\/span>><\/span><\/span>\n        <\/span><<\/span>ImportType<\/span>><\/span>Synchronize table with import file<\/span><\/<\/span>ImportType<\/span>><\/span><\/span>\n        <\/span><<\/span>ScheduledTaskId<\/span>><\/span>3347<\/span><\/<\/span>ScheduledTaskId<\/span>><\/span><\/span>\n        <\/span><<\/span>AddedEntries<\/span>><\/span>0<\/span><\/<\/span>AddedEntries<\/span>><\/span><\/span>\n        <\/span><<\/span>Status<\/span>><\/span>Error<\/span><\/<\/span>Status<\/span>><\/span><\/span>\n        <\/span><<\/span>ErrorDescription<\/span>><\/span>Nie ma tabeli o podanej nazwie pliku: test_importu.csv<\/span><\/<\/span>ErrorDescription<\/span>><\/span><\/span>\n      <\/span><\/<\/span>ImportReport<\/span>><\/span><\/span>\n    <\/span><\/<\/span>ImportReports<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Subscribers import<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET <\/span><\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/ImportReports?ReportType=Subscribers&apiKey= YOUR_API_KEY_HERE&StartDate=2017-10-31 HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nContent-Encoding: gzip <\/span><\/span>\nVary: Accept-Encoding <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nSet-Cookie: ASP.NET_SessionId=znbbf255rwgtzketrup04q55; path=\/; HttpOnly <\/span><\/span>\nX-AspNetMvc-Version: 5.2<\/span><\/span>\nX-AspNet-Version: 4.0.30319 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Fri, 31 Oct 2014 11:05:25 GMT <\/span><\/span>\nContent-Length: 651  <\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span>><\/span><\/span>\n    <\/span><<\/span>ImportReports<\/span>><\/span><\/span>\n      <\/span><<\/span>ImportReport<\/span>><\/span><\/span>\n        <\/span><<\/span>Id<\/span>><\/span>125<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n        <\/span><<\/span>FileName<\/span>><\/span>test_importu.csv<\/span><\/<\/span>FileName<\/span>><\/span><\/span>\n        <\/span><<\/span>ImportDate<\/span>><\/span>2017-11-10T07:21:33<\/span><\/<\/span>ImportDate<\/span>><\/span><\/span>\n        <\/span><<\/span>FinishedDate<\/span>><\/span>2017-11-10T07:35:26.283<\/span><\/<\/span>FinishedDate<\/span>><\/span><\/span>\n        <\/span><<\/span>ListId<\/span>><\/span>29<\/span><\/<\/span>ListId<\/span>><\/span><\/span>\n        <\/span><<\/span>ListName<\/span>><\/span>List_123<\/span><\/<\/span>ListName<\/span>><\/span><\/span>\n        <\/span><<\/span>ImportType<\/span>><\/span>Add new subscribers and update data of subscribers existing on the list<\/span><\/<\/span>ImportType<\/span>><\/span><\/span>\n        <\/span><<\/span>MatchingMode<\/span>><\/span>Email<\/span><\/<\/span>MatchingMode<\/span>><\/span><\/span>\n        <\/span><<\/span>TotalRows<\/span>><\/span>41<\/span><\/<\/span>TotalRows<\/span>><\/span><\/span>\n        <\/span><<\/span>ValidRows<\/span>><\/span>34<\/span><\/<\/span>ValidRows<\/span>><\/span><\/span>\n        <\/span><<\/span>InvalidRows<\/span>><\/span>3<\/span><\/<\/span>InvalidRows<\/span>><\/span><\/span>\n        <\/span><<\/span>ConflictingRecords<\/span>><\/span>4<\/span><\/<\/span>ConflictingRecords<\/span>><\/span><\/span>\n        <\/span><<\/span>DuplicatedRows<\/span>><\/span>0<\/span><\/<\/span>DuplicatedRows<\/span>><\/span><\/span>\n        <\/span><<\/span>Entries<\/span>><\/span><\/span>\n            <\/span><<\/span>Email<\/span>><\/span><\/span>\n                <\/span><<\/span>Valid<\/span>><\/span>38<\/span><\/<\/span>Valid<\/span>><\/span><\/span>\n                <\/span><<\/span>Duplicated<\/span>><\/span>0<\/span><\/<\/span>Duplicated<\/span>><\/span><\/span>\n                <\/span><<\/span>Invalid<\/span>><\/span>3<\/span><\/<\/span>Invalid<\/span>><\/span><\/span>\n                <\/span><<\/span>Empty<\/span>><\/span>0<\/span><\/<\/span>Empty<\/span>><\/span><\/span>\n            <\/span><\/<\/span>Email<\/span>><\/span><\/span>\n            <\/span><<\/span>Phone<\/span>><\/span><\/span>\n                <\/span><<\/span>Valid<\/span>><\/span>41<\/span><\/<\/span>Valid<\/span>><\/span><\/span>\n                <\/span><<\/span>Duplicated<\/span>><\/span>0<\/span><\/<\/span>Duplicated<\/span>><\/span><\/span>\n                <\/span><<\/span>Invalid<\/span>><\/span>0<\/span><\/<\/span>Invalid<\/span>><\/span><\/span>\n                <\/span><<\/span>Empty<\/span>><\/span>0<\/span><\/<\/span>Empty<\/span>><\/span><\/span>\n            <\/span><\/<\/span>Phone<\/span>><\/span><\/span>\n            <\/span><<\/span>CustomSubscriberId<\/span>><\/span><\/span>\n                <\/span><<\/span>Valid<\/span>><\/span>0<\/span><\/<\/span>Valid<\/span>><\/span><\/span>\n                <\/span><<\/span>Duplicated<\/span>><\/span>0<\/span><\/<\/span>Duplicated<\/span>><\/span><\/span>\n                <\/span><<\/span>Invalid<\/span>><\/span>0<\/span><\/<\/span>Invalid<\/span>><\/span><\/span>\n                <\/span><<\/span>Empty<\/span>><\/span>0<\/span><\/<\/span>Empty<\/span>><\/span><\/span>\n            <\/span><\/<\/span>CustomSubscriberId<\/span>><\/span><\/span>\n        <\/span><\/<\/span>Entries<\/span>><\/span><\/span>\n        <\/span><<\/span>Subscriptions<\/span>><\/span><\/span>\n            <\/span><<\/span>Email<\/span>><\/span><\/span>\n                <\/span><<\/span>Added<\/span>><\/span>4<\/span><\/<\/span>Added<\/span>><\/span><\/span>\n                <\/span><<\/span>Updated<\/span>><\/span>33<\/span><\/<\/span>Updated<\/span>><\/span><\/span>\n                <\/span><<\/span>Replaced<\/span>><\/span>0<\/span><\/<\/span>Replaced<\/span>><\/span><\/span>\n                <\/span><<\/span>SystemRejected<\/span>><\/span>0<\/span><\/<\/span>SystemRejected<\/span>><\/span><\/span>\n                <\/span><<\/span>Blacklisted<\/span>><\/span>1<\/span><\/<\/span>Blacklisted<\/span>><\/span><\/span>\n                <\/span><<\/span>Unsubscribed<\/span>><\/span>0<\/span><\/<\/span>Unsubscribed<\/span>><\/span><\/span>\n            <\/span><\/<\/span>Email<\/span>><\/span><\/span>\n            <\/span><<\/span>Phone<\/span>><\/span><\/span>\n                <\/span><<\/span>Added<\/span>><\/span>35<\/span><\/<\/span>Added<\/span>><\/span><\/span>\n                <\/span><<\/span>Updated<\/span>><\/span>0<\/span><\/<\/span>Updated<\/span>><\/span><\/span>\n                <\/span><<\/span>Replaced<\/span>><\/span>0<\/span><\/<\/span>Replaced<\/span>><\/span><\/span>\n                <\/span><<\/span>SystemRejected<\/span>><\/span>1<\/span><\/<\/span>SystemRejected<\/span>><\/span><\/span>\n                <\/span><<\/span>Blacklisted<\/span>><\/span>5<\/span><\/<\/span>Blacklisted<\/span>><\/span><\/span>\n                <\/span><<\/span>Unsubscribed<\/span>><\/span>0<\/span><\/<\/span>Unsubscribed<\/span>><\/span><\/span>\n            <\/span><\/<\/span>Phone<\/span>><\/span>   <\/span><\/span>\n        <\/span><\/<\/span>Subscriptions<\/span>><\/span><\/span>\n      <\/span><\/<\/span>ImportReport<\/span>><\/span><\/span>\n    <\/span><\/<\/span>ImportReports<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":13,"featured_media":0,"parent":3551,"menu_order":0,"template":"","format":"standard","emp-category":[],"class_list":["post-10935","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10935","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/13"}],"version-history":[{"count":1,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10935\/revisions"}],"predecessor-version":[{"id":10936,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10935\/revisions\/10936"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3551"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=10935"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=10935"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}