Iterable Export Integration

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Iterable is a complete cross-channel customer engagement platform. Use it to message your customers via email, SMS, embedded messages, in-app messages, push notifications, and web push notifications—and to grow your customer base, boost engagement, and increase user lifetime value.

This integration enables Treasure Data users to add or remove subscribers from an Iterable list.

• Use Audience Studio to Schedule and View your Activation
• Optionally Schedule the Query Export Jobs

Prerequisites

• Basic Knowledge of Treasure Data
• Basic knowledge of Iterable

Obtaining API Key

See Iterable Import Integration

Use the TD Console to Create Your Connection

Using existed Connection

Authentications created for Iterable can be reused across input and output connectors. Search for existing authentications from Integrations Hub > Authentications.

Create a New Connection

See Iterable Import Integration for creating new connections to Iterable using an API Key.

Define your Query

Example Query

SELECT email, user_id FROM table my_table

Add users to audience lists.

The table below describes columns that can be included in your query results and how those will be sent to Iterable.

Remove users from audience lists

The connector only supports these fields.

Use Query Export Result to export data

Set the following parameters:

(Optional) Schedule Query Export Jobs

You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify.

Treasure Data's scheduler feature supports periodic query execution to achieve high availability.

When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored.

For example, if the cron schedule is '0 0 1 * 1', then the 'day of month' specification and 'day of week' are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed.

Scheduling your Job Using TD Console

1. Navigate to Data Workbench > Queries

2. Create a new query or select an existing query.

3. Next to Schedule, select None.

4. In the drop-down, select one of the following schedule options:

   Drop-down Value	Description
   Custom cron...	Review Custom cron... details.
   @daily (midnight)	Run once a day at midnight (00:00 am) in the specified time zone.
   @hourly (:00)	Run every hour at 00 minutes.
   None	No schedule.

Custom cron... Details

 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
 |    |    |    +---------- month (1 - 12)
 |    |    +--------------- day of month (1 - 31)
 |    +-------------------- hour (0 - 23)
 +------------------------- min (0 - 59)

The following named entries can be used:

• Day of Week: sun, mon, tue, wed, thu, fri, sat.
• Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.

A single space is required between each field. The values for each field can be composed of:

1. (Optional) You can delay the start time of a query by enabling the Delay execution.

Execute the Query

Save the query with a name and run, or just run the query. Upon successful completion of the query, the query result is automatically exported to the specified destination.

(Optional) You can delay the start time of a query by enabling the Delay execution.

Activate a Segment in Audience Studio

You can also send segment data to the target platform by creating an activation in the Audience Studio.

1. Navigate to Audience Studio.
2. Select a parent segment.
3. Open the target segment, right-mouse click, and then select Create Activation.
4. In the Details panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters.
5. Customize the activation output in the Output Mapping panel.

• Attribute Columns
  • Select Export All Columns to export all columns without making any changes.
  • Select + Add Columns to add specific columns for the export. The Output Column Name pre-populates with the same Source column name. You can update the Output Column Name. Continue to select + Add Columnsto add new columns for your activation output.
• String Builder
  • + Add string to create strings for export. Select from the following values:
    • String: Choose any value; use text to create a custom value.
    • Timestamp: The date and time of the export.
    • Segment Id: The segment ID number.
    • Segment Name: The segment name.
    • Audience Id: The parent segment number.

6. Set a Schedule.

• Select the values to define your schedule and optionally include email notifications.

7. Select Create.

(Optional) Export Integration Using the CLI

You can also use CLI(Toolbelt) for Result Export to Iterable.

You need to specify the information for export to your Iterable server as the --result option of td query command. About td query command, you can refer to this article.

The format of the option is JSON and the general structure is as follows.

{  "type" : "iterable"  "api_key" : "xxxxxxxxxxxxxx"  region : "us" # or eu  action: "remove" # or add  list_id: "xxxxxxxxxxx"  channel_unsubscribe: "false"  skip_invalid_data: "true"}

Parameters

Example for Usage

$ td query --result '{"type":"iterable","api_key":"xxx","region":"us","action":"remove","list_id":"xxxx", "skip_on_invalid_records":true,"channel_unsubscribe": "false"}' -d sample_datasets "select * from www_access" -T presto

Example Workflow for Iterable

The action accepts the following values:

• Add
• Remove

_export:  td:  database: td.database+iterable_export_task:  td>: export_iterable.sql  database: ${td.database}  result_connection: iterable  result_settings:    type: iterable    region : us # or eu    action: add    list_id: 769207    skip_invalid_data: false

References

• API Overview: https://api.iterable.com/api/docs