How can we help?

Overview

The message analytics export resource creates an export job to download and store a file of message analytics from the Cordial database. The exported file can be downloaded via Cordial UI, FTP/SFTP, or sent to an Amazon S3 or Google Cloud Storage bucket.

API set name: messageanalyticsexport

Message experiment results are not available for export via the message analytics export API endpoint. Experiment results can be exported for individual batch and automated messages in the UI.

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's important to note that this resource is not a collection of exports. This endpoint initiates export processing by creating an export job.
• Export status information is available through the jobs API and on the Jobs page in the UI.
• Export supports file types CSV and JSON.
• Export files made available for download via the UI will be stored for 30 days from the date of the export.

Authentication

Cordial's core APIs use HTTPS Basic Authentication (BA). From within the Cordial platform, you can generate an encoded API key for your account and use it for authorization.

• Learn more about Cordial API authentication here.

Methods, parameters, and examples

• POST/v2/messageanalyticsexport

POST/v2/messageanalyticsexport

Required Parameters

Examples

UI - CSV

The following will initiate an export job of sent batch message analytics for March 25 into a CSV file that will be available via the UI on the Jobs page.

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

FTP - CSV

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

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

Amazon S3

The following will initiate an export job of sent batch message analytics for March 25 into a CSV file via Amazon S3.

{
    "name": "batch_analytics_m25",
    "exportType": "csv",
    "destination": {
        "type": "s3",
        "aws_access_key_id": "A1234567890",
        "aws_secret_access_key": "B1234567890",
        "aws_bucket": "my_bucket",
        "aws_region": "us-west-2",
        "path": "/folder"
    },
    "showHeader": true,
    "selected_timeframe_start": "2025-03-24T00:00:00.000Z",
    "selected_timeframe_end": "2025-03-25T23:59:59.999Z",
    "type": "batch"
}

Google Cloud Storage

The following will initiate an export job of sent batch message analytics for March 25 into a CSV file via Google Cloud Storage (GCS).

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

FTP - JSON

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

Each record is returned as a separate line consisting of a single JSON object (not an array of JSON objects).

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

Additional examples

The following will initiate an export job of sent automation message analytics aggregated by message type and totals for March 25 into a CSV file that will be available via the UI on the Jobs page.

{
   "name": "batch_analytics_m25",
   "exportType": "csv",
   "destination": {
      "type": "aws"
   },
   "showHeader": true,
   "selected_timeframe_start": "2025-03-24T00:00:00.000Z",
   "selected_timeframe_end": "2025-03-25T23:59:59.999Z",
   "type": "automation",
   "rollupAutomations": true
}

The following will initiate an export job of sent batch message analytics aggregated by audience names into a CSV file that will be available on the Jobs page in the UI.

{
   "name": "API-group-by-audience",
   "exportType": "csv",
   "destination": {
       "type": "ftp",
       "server": "ftp.example.com",
       "port": 21,
       "username": "cordial@example.com",
       "password": "cordial",
       "path": "/folder"
   },
   "showHeader": true,
   "selected_timeframe_start": "2025-03-24T00:00:00.000Z",
   "selected_timeframe_end": "2025-03-25T23:59:59.999Z",
   "type": "batch",
   "selected_audience_names": ["all_contacts", "another_audience_name"]
}

The following JSON object includes all available analytics column headers. Remove any fields as desired.

{
 "columnHeaders": [
   {"name": "id", "label": "Message ID"},
   {"name": "name", "label": "Message Name"},
   {"name": "subject", "label": "Message Subject"},
   {"name": "tags", "label": "Message Tags"},
   {"name": "sendTime", "label": "Sent Date"},
   {"name": "totalSent", "label": "Sent Total"},
   {"name": "clicksTotal", "label": "Click Total"},
   {"name": "clicksUnique", "label": "Clicks Unique"},
   {"name": "ctor", "label": "Click To Open Ratio"}
 ]
}

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

https://<path>/v2/messageanalyticsexport

Error responses

The Cordial API will return an error object with an errorKey and message if there is a problem with an API call. Below is a list of errors specific to the Message Analytics Export API endpoint, along with suggested modifications to resolve each error. If you receive an error from this API endpoint that is not listed in this table, it is likely recorded within the Global API Error Responses page.