Exports collection allows scheduling (asynchronous) exports of lists and segments. Data is exported in CSV format.<\/p>\n\n\n\n
You may choose what fields will be exported (system and custom fields) by sending a POST request with different parameters.<\/p>\n\n\n\n
Export status may be then checked by sending a GET request and when the export is ready, the request will return an URL to file available for download.<\/p>\n\n\n\n
Data part of request for scheduling an export.<\/p>\n\n\n\n
Data element children:<\/p>\n\n\n\n Field element children:<\/p>\n\n\n\n Property element children:<\/p>\n\n\n\n Available system fields to export:<\/p>\n\n\n\n *It is only valid when Doublt Opt-In list is exported. Otherwise, trying to use it will result in an “Unknown field name” error.<\/p>\n\n\n\n For customers with SMS\/MMS integration enabled there are additional fields available:<\/p>\n\n\n\n Method returns ID of scheduled export. ID can be used to get export status using GET method.<\/p>\n\n\n\n Response Data element:<\/p>\n\n\n\n Simple list export<\/strong><\/p>\n\n\n\n Request:<\/p>\n\n\n\nElement\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> Type<\/td> string<\/td> Export type. Required. Valid values are:
List – exporting subscriber list
Segment – exporting subscriber segment<\/td><\/tr>ListId<\/td> integer<\/td> ID of subscriber list to export. Required when Type=List. Otherwise ignored.<\/td><\/tr> SegmentId<\/td> integer<\/td> ID of subscriber segment to export. Required when Type=Segment. Otherwise ignored.<\/td><\/tr> Fields<\/td> complex<\/td> Collection of Field elements. List of system fields to be exportd (e.g. Email, Firstname, Vendor etc). At least one field or custom property must be selected. See table below for all available system fields. <\/td><\/tr> Properties<\/td> complex<\/td> Collection of Property elements. List of custom subscriber properties to be exported. Properties are identified by ID. See example requests below.<\/td><\/tr> FileFormat<\/td> string<\/td> Format in wich report will be returned. Valid values are:
Csv
Excel<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nElement\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> (Field element content)<\/td> string<\/td> System field name.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> (Property element content)<\/td> int<\/td> Custom property ID.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Name<\/th> Description<\/th><\/tr><\/thead> Id<\/td> Subscriber’s ID.<\/td><\/tr> FirstName<\/td> Subscriber’s firstname.<\/td><\/tr> LastName<\/td> Subscriber’s lastname.<\/td><\/tr> Email<\/td> Subscriber’s email.<\/td><\/tr> EmailMd5<\/td> MD5 of subscriber’s email.<\/td><\/tr> EmailSha256<\/td> SHA256 of subscriber’s email.<\/td><\/tr> CustomSubscriberId<\/td> Subscriber’s custom ID.<\/td><\/tr> IP<\/td> IP address subscriber used to subscribe.<\/td><\/tr> Vendor<\/td> Subscriber’s vendor (source).<\/td><\/tr> TrackingCode<\/td> Tracking code subscriber used during subscription.<\/td><\/tr> GeoCountry<\/td> Subscriber’s country recognized from IP address using geolocation.<\/td><\/tr> GeoState<\/td> Subscriber’s state\/province.<\/td><\/tr> GeoCity<\/td> Subscriber’s city.<\/td><\/tr> GeoZipCode<\/td> Subscriber’s ZIP\/postal code.<\/td><\/tr> LastActivity<\/td> Date of last subscriber’s activity (click, open, visiting preference center etc).<\/td><\/tr> LastMessage<\/td> Date of last message sent to subscriber.<\/td><\/tr> LastEmail<\/td> Date of last email message sent to subscriber.<\/td><\/tr> LastOpenEmail<\/td> Date of last time subscriber opened an email message.<\/td><\/tr> LastClickEmail<\/td> Date of last time subscriber clicked a link in email message.<\/td><\/tr> SubscriptionDate<\/td> Date of subscription to a particular list (if the export type is segment, the date of the earliest subscription is used).<\/td><\/tr> ConfirmationDate<\/td> Date of subscription confirmation.*<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Name<\/th> Description<\/th><\/tr><\/thead> Phone<\/td> Subscriber’s phone number.<\/td><\/tr> LastSmsMms<\/td> Date of last SMS\/MMS message sent to subscriber<\/td><\/tr> LastClickSmsMms<\/td> Date of last time subscriber clicked a link in SMS\/MMS message.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Response<\/strong><\/h3>\n\n\n\n
Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> (Data element content)<\/td> int<\/td> ID of scheduled export.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Examples<\/strong><\/h3>\n\n\n\n