Sailthru

The Sailthru Connector provides automated access to the Sailthru Stats API.

• Prerequisites
• Scheduling
• Parameters
• Sample Switchboard Script

Prerequisites

The Sailthru connector requires you to create a Key in the Key Editor with the following properties:

api key

you can obtain your api key from the API & Postbacks Settings page in My Sailthru. Click the lock icon to display your credentials.

api secret

you can obtain your api secret from the API & Postbacks Settings page in My Sailthru. Click the lock icon to display your credentials.

Scheduling

The Sailthru connector can be scheduled to ingest data once per day at a user-defined hour and timezone.

By default, the connector will run once at 6am PT.

See Daily Scheduling for more information.

Stats Bundle Report

Parameters

organization_name string

required

name of the organization for which the download is performed

Sample Switchboard Script

download bundle sailthru { {
      type: "sailthru:stats_bundle";
      key: "sailthru_key";
      organization_name: "Organization name"; # name of the organization for which the download is performed
      table list using {*};
      table blast using {*};
      table send using {*};
      table aggregate using {*};
      table list_id_level using {*};
      table blast_id_level using {*};
      table send_id_level using {*};
       
      # allows daily schedule
  } };

Export List

This report retrieves data from Sailthru “Export List Data” Endpoint.

Parameters

fields string list

optional

The field(s) of data to export. Profile ID, Email Hash and extid are defaults and will be always in the response. Consult the documentation on the export_list_data endpoint for a list of available fields.

newsletter_list string list

required

Names of the lists to export

vars string list

optional

Custom fields added to user profiles. See the Sailthru documentation on setting custom fields for more information.

Sample Switchboard Script

download t from {
            type: "sailthru:export_list";
            key: "sailthru_key";
            newsletter_list: ["LIST_1","LIST_2"];
            fields: ["domain","clicks"];
            vars: ["var_1","var_2"];
        } using { * };