Message Analytics Export

API Set Name: messageanalyticsexport

• POST / messageanalyticsexport

API Description and Functional Purpose:

The message analytics export resource creates an export job to download and store a file of message analytics from the Cordial database to an external location.

Additional information:

• This resource uses the JSON request information to define the target host location of the file, the transport protocol, the external host login authentication information and the fields to include in the file.
• It is important to note that this resource is not a collection of exports, but is a resource that initiates export processing by creating an export job.
• Export status information is available through the "jobs" resource.
• Export supports file type "CSV" and "JSON".
• Export files in the UI will be stored for 30 days from the date of the export.

POST /messageanalyticsexport

Parameters

* Required

"columnHeaders": [
{
"name": "_id",
"label": "Message ID"
},
{
"name": "name",
"label": "Message Name"
},
{
"name": "subject",
"label": "Subject"
},
{
"name": "sendTime",
"label": "Sent Date"
},
{
"name": "totalSent",
"label": "Sent Total"
},
{
"name": "totalBounced",
"label": "Bounced Total"
},
{
"name": "bounceRate",
"label": "Bounce Rate"
},
{
"name": "bouncedHard",
"label": "Bounced Hard"
},
{
"name": "bouncedSoft",
"label": "Bounced Soft"
},
{
"name": "delivered",
"label": "Delivered total"
},
{
"name": "deliveryRate",
"label": "Delivered rate"
},
{
"name": "opensTotal",
"label": "Opens Total"
},
{
"name": "opensUnique",
"label": "Opens Unique"
},
{
"name": "openRate",
"label": "Open Rate"
},
{
"name": "clicksTotal",
"label": "Click Total"
},
{
"name": "clicksUnique",
"label": "Clicks Unique"
},
{
"name": "ctor",
"label": "CTOR"
},
{
"name": "complaintsTotal",
"label": "Complaints"
},
{
"name": "complaintRate",
"label": "Complaint Rate"
},
{
"name": "optoutsTotal",
"label": "Opt Outs"
},
{
"name": "optoutRate",
"label": "Opt Out Rate"
},
{
"name": "revenue",
"label": "Revenue"
},
{
"name": "totalPurchases",
"label": "Total Purchases"
},
{
"name": "aov",
"label": "AOV"
}
]

Example JSON Requests

The following will initiate an export job of all sent batch message analytics into a CSV file that will be available to be downloaded via the UI.

{
  "name": "batch_analytics_30days",
  "exportType": "csv",
  "destination": {
    "type": "aws"
  },
  "showHeader": true,
  "selected_timeframe_start": "2018-03-24T00:00:00.000Z",
  "selected_timeframe_end": "2018-03-24T23:59:59.999Z",
  "type": "batch"
}

The following will initiate an export job of all sent batch message analytics into a CSV file via FTP download.

{
  "name": "batch_analytics_30days",
  "exportType": "csv",
  "destination": {
    "type": "ftp",
    "server": "ftp.example.com",
    "port": 21,
    "username": "cordial@example.com",
    "password": "cordial",
    "path": "/folder"
  },
  "showHeader": true,
  "selected_timeframe_start": "2018-03-24T00:00:00.000Z",
  "selected_timeframe_end": "2018-03-24T23:59:59.999Z",
  "type": "batch"
}

The following will initiate an export job of all sent batch message analytics into a CSV file via the GCS:

{
  "name": "batch_analytics_30days",
  "exportType": "csv",
  "destination": {
    "type": "gcs",
    "gcs_bucket": "bucketname",
    "path": "/folder"
  },
  "showHeader": true,
  "selected_timeframe_start": "2018-03-24T00:00:00.000Z",
  "selected_timeframe_end": "2018-03-24T23:59:59.999Z",
  "type": "batch"
}

The following will initiate an export job of all sent batch message click analytics into a JSON file via an ftp download. Note that each record is returned as a separate line consisting of a single JSON object (not an array of JSON objects).

{
  "name": "batch_clicks_30days",
  "exportType": "json",
  "destination": {
    "type": "ftp",
    "server": "ftp.example.com",
    "port": 21,
    "username": "username@example.com",
    "password": "password",
    "path": "./"
  },
  "showHeader": true,
  "selected_timeframe_start": "2018-03-24T00:00:00.000Z",
  "selected_timeframe_end": "2018-03-24T23:59:59.999Z",
  "type": "batch",
  "columnHeaders": [
{
"name": "_id",
"label": "Message ID"
},
{
"name": "name",
"label": "Message Name"
},
{
"name": "subject",
"label": "Subject"
},
{
"name": "sendTime",
"label": "Sent Date"
},
{
"name": "totalSent",
"label": "Sent Total"
},
{
"name": "clicksTotal",
"label": "Click Total"
},
{
"name": "clicksUnique",
"label": "Clicks Unique"
},
{
"name": "ctor",
"label": "CTOR"
}
]
}

Example Request URIs

The following URI in conjunction with the JSON will perform the POST.

http://<path>/messageanalyticsexport