Contact Activity Export

API Set Name: contactactivityexport

• POST /contactactivityexport

API Description and Functional Purpose:

The contactactivityexport resource creates an export job to download and store a file of contact activities 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 /contactactivityexport

Parameters

* Required

Note: When destination type is "S3", if compress value is false and limitRecordsPerFile is set, each chunk will be uploaded as soon as it's ready. If compress value is true and limitRecordsPerFile is set, all chunks will be uploaded together when export is complete.

Example JSON Requests

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

{
  "name": "batch-30days",
  "exportType": "csv",
  "destination": {
    "type": "aws"
  },
  "showHeader": true,
  "selected_timeframe_start": "2018-02-01T19:25:24.528Z",
  "selected_timeframe_end": "2018-02-27T19:25:24.528Z",
  "selected_message_type": "batch",
  "compress": false
}

The following will initiate an export job of all batch message activities into a CSV file via an ftp download.

{
  "name": "batch-30days",
  "exportType": "csv",
  "destination": {
    "type": "ftp",
    "server": "ftp.example.com",
    "port": 21,
    "username": "cordial@example.com",
    "password": "cordial",
    "path": "./"
  },
  "showHeader": true,
  "selected_timeframe_start": "2018-02-01T19:25:24.528Z",
  "selected_timeframe_end": "2018-02-27T19:25:24.528Z",
  "selected_message_type": "batch",
  "compress": false
}

The following will initiate an export job of all bounce events 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": "bounce-30days",
  "exportType": "json",
  "destination": {
    "type": "ftp",
    "server": "ftp.example.com",
    "port": 21,
    "username": "username@example.com",
    "password": "password",
    "path": "./"
  },
  "selected_timeframe_start": "2018-02-01T19:25:24.528Z",
  "selected_timeframe_end": "2018-02-27T19:25:24.528Z",
  "selected_action_name": "bounce",
  "showAllProperties":false,
  "compress": false,
  "columnHeaders": [
    {
      "name": "email",
      "label": "Email"
    },
    {
      "name": "action",
      "label": "Action"
    },
    {
      "name": "system_properties.bt",
      "label": "Bounce Type"
    },
    {
      "name": "time",
      "label": "Time"
    },
    {
      "name": "mcID",
      "label": "Message Contact ID"
    },
    {
      "name": "msID",
      "label": "Message Send ID"
    },
    {
      "name": "mdtID",
      "label": "Message Template ID"
    },
    {
      "name": "_id",
      "label": "System Event ID"
    },
    {
      "name": "cID",
      "label": "Contact ID"
    },
    {
      "name": "first",
      "label": "Unique Event"
     }
  ]
}

Example Request URIs

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

http://<path>/contactactivityexport