Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

FTP-based data synchronization is synchronizations are not available by default (additional chargecharges will apply), contact your account manager to get receive a quotequotation.

To In order to have a data synchronization set up, you need to have an active MailUp account (not a free trial).

Data Sync (S)FTP Export allow you to export recipients and related data or statistical data about Email or SMS channel from your MailUp Account by simply generating a .csv file onto an SFTP server.
Using this service you can decide when running the file exchange to export from MailUp to your applications

In case you need any further information or custom integrations, please do not hesitate to contact your sales representative.

The automated , (S)FTP-based exports  can be preferable compared to API calls when the volume of the information to be exported is significant.An instance of a Datasync (S)FTP Export (hereinafter referred to as Instancewill be exports can be a better approach than using the statistics API counterpart, especially if the data expected in return is allegedly significant.

The (S)FTP export will deliver all data in one single csv file, as opposed to using the API which might possibly require an array of callbacks to retrieve the same amount of data for the same time frame. 

An (S)FTP Export data sync (hereinafter referred as to an Instance) is configured to export data from one or more more MailUp Lists and about one MailUp channel (email, SMS).
Based on the kind of data export chose you can specify to add to the report a specific subset of recipient fieldsIt is possible enable instances  and referring to either one bewteen email or SMS generated traffic.

It is possible to enable one or more instances (tipically one for each kind) of the following (S)FTP data export types:

When an Instance is active you can defineWith every instances, it can be defined:

Anchor
data
data
What data is to be included in the report

These information change based The data the export file includes depends on the kind of export you have boughtpurchased, for this reason they are detailed each in the proper their related help page below:

Properties of the exported file

You can define how the report CSV is built.You can choose some technical data about will ultimately look like. You can also set properties that define the CSV structure and properties of the physical file the report will be contained into:

  • Separator, the character used to separate the column of the CSV report: you can choose between semicolon ( ; ), or comma ( , ), or pipe ( | )

  • Delimiter, the character used to

    encole

    enclose data when needed: you can choose between double

    quote

    quotes ( " ), or single quote ( ' )

  • Datatime Format for any date/time field type

  • File encoding, the encoding type of the physical CSV file delivered:

    you can choose

    one between UTF-8 (includes both Latin and other alphabets characters)

    ,

    or ANSI (include only Latin characters) can be selected. 

Anchor
env
env
Environments and export timeframe

You can define which MailUp lists you want to extract data from and the extraction period.

Extraction period is the timeframe which the report refers to.
Usually you can configure an Instance instance to generate deliver a report containing all of the data generated in from the last 24 hours or from the last export executeddate/time the same export ran successfully last time

Expand
titleExamples
  • if you have an Instance configured to

    be executed every

    run every week on Monday at 10:00 and to generate a report containing all of the data

    generated

    from the last export executed, the report generated every monday will contains the data generated from the past monday (a week time of data).

  • if you have an Instance configured to be executed every day at 10:00 and to generate a report containing all the data generated from the last export executed, the report generated every day will contains the data generated from yesterday (a day of data).

  • if you have an Instance configured to be executed every day at 10:00 and to generate a report containing all the data generated in the last 24 hours, the report generated every hours will contains the data generated in the last 24 hours (a day of data).


These settings can change based on the kind of (S)FTP export. You can find further details in the proper each specific help page.:

Anchor
sch
sch
Schedulation and delivery of the export

You It can definebe defined:

  • when the data export will be executed: for example every day at 10:00

    rather than every week on tuesday

    or every Tuesday at 10:00

    and so on

    .

  • where the file CSV

    generated

    should be delivered: you can

    get

    retrieve the file from the MailUp SFTP server (

    this

    which is the default behavior),

    rather than configure

    as opposed to having the Instance configured to deliver the csv file

    on

    over an external (S)FTP server

  • characteristics of the generated properties of the generated CSV file: mainly the name of the file

These settings can change based on the kind of (S)FTP export. You can find further details in the proper help page.Further details can be found at the related help page for each type of export:

  • Export of email subscribers

  • Export of email unsubscribers

  • Export of email statistics (delivered, opens, clicks, bounces)

  • Export of SMS statistics

You can also define the name of the CSV file CSV that will be generated.

title
Info

Important Note

In case of incremental export we suggest you to add use the Date / time in the (timestamp) as part of the csv file name. In this way Doing so, the date and time of the extraction will be added to the name of the generated file, avoiding to override file generated by previous export.delivered file, preventing the system from overwriting csv files coming from previous export sessions/periods

Table of Contents