# Rokt Via SFTP Export Integration

Rokt is an **e-commerce engagement and monetization platform** that specializes in presenting personalized offers or ads during the transaction moment (for example, immediately after a purchase)

This document describes how to integrate Treasure Data CDP with Rokt using **Secure FTP (SFTP)** to upload custom audience lists and conversion data. By leveraging file-based integration, businesses can automate the synchronization of key marketing data without relying on real-time API connectivity.

## Use Cases for CDP Integration

### CDP to Rokt: Send Segment Data to Enhance Personalization

**Goal:** Improve offer targeting by leveraging audience segments built in the CDP.

**Use Cases:**

- Suppress offers for products/services the customer already owns (e.g., exclude existing credit card holders).
- Prioritize high-value offers for VIP or loyal customers.


### Use CDP Attributes in Rokt to Drive Offer Personalization

**Goal:** Leverage CDP-enriched attributes (e.g., inferred interests, loyalty scores) to personalize the Rokt experience.

**Use Cases:**

- Use CDP-generated attributes like age brackets, product affinities, or churn risk to influence Rokt’s offer selection.


### CDP to Rokt (Conversions)

**Goal:** Export conversion events (e.g., purchases, sign-ups, cancellations) from the CDP and send them to Rokt via file upload.

**Use Cases:**

- Enhance campaign optimization.
- Improve accuracy of attribution.


## Prerequisites

- Contact your Rokt account manager to obtain SFTP credentials.
- Ensure your parent segment in CDP includes either **plaintext email** or **SHA-256 hashed email**.


## Static IP Address of Treasure Data Integration

If your security policy requires IP whitelisting, you must add Treasure Data's IP addresses to your allowlist to ensure a successful connection.

Please find the complete list of static IP addresses, organized by region, at the following link:
[https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/](https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/)

## Basic Usage

Rokt supports importing the following via SFTP:

- **Custom Audience Lists**: For inclusion or exclusion targeting in campaigns.
- **Conversion Data**: For campaign measurement, optimization, and attribution.


For more details, see:

- [Import custom audiences | Rokt documentation](https://docs.rokt.com/user-guides/rokt-ads/audiences/how-to/import-custom-audiences/#import-via-file-transfer)
- [Import conversions via file transfer | Rokt documentation](https://docs.rokt.com/user-guides/rokt-ads/conversions/how-to/file-transfer)


### Create a New Connection

You must create and configure the data connection on TD Console before running your query. As part of the data connection, you provide authentication to access the integration using the following steps:

1. Open the TD Console.
2. Navigate to **Integrations Hub > Catalog.**
3. Search for **SFTP_V2** and then select **Create Authentication**.
![](/assets/sftp_v2b.c8f58e8781a6c70bee0ad0cb1255b782c0c4d235094eff59ca1c59e87444e915.e972ba82.png)
4. Provide the connection credentials.
![](/assets/sftpv2credentials.bca13f7f57ab8c6ff619e66f6eaebe96d234ac91d7b1cc76c411a34be79b320e.e972ba82.png)
**Authentication Fields**


| Parameter | Data Type | Description |
|  --- | --- | --- |
| Host  Required | string | ftp.rokt.com |
| Port  Required | string | 22 |
| User  Required | string | The user name used to connect to the remote FTP instance |
| Authentication mode  Required | string | Choose Public / Private key pair. |
| Secret key file  Optional | string | Reach out to your Rokt Account Manager to request access to the Rokt SFTP. Once you've been granted access, you should receive an email from Rokt with the subject "You've been granted access to Rokt's SFTP server." |
| Passphrase for secret key file  Optional | string | The passphrase of the provided secret file, for some algorithms that require |
| Retry limit  Required | int | Number of times to retry a failed connection (default 10) |
| Timeout  Required | int | Connection timeout in seconds (default 600) |


1. Select **Continue**, enter a name for the Authentication.
2. Select **Done**.


### Configure a Query Result for Export

The TD Console supports multiple ways to export data. Complete the following steps to export data from the Data Workbench.

1. Navigate to **Data Workbench** > **Queries**.
2. Select **New Query** and define your query.
3. Select **Export Results** and provide the data export configuration.
4. Use an existing integration or create a new one.
5. Configure the export parameters and select **Done**.
![](/assets/sftp_v2-server-export-integration-2025-04-06.c5713f1e1dc5e65b79f243661b81a0962c724121d6b5acdc5bc8d7bccb69eed7.e972ba82.png)
**Export Configuration Parameters**


| Parameter  | Data Type  | Description  |
|  --- | --- | --- |
| Is user directory Root?
**Required**
 | boolean
 | Choose "No"
 |
| Path prefix
**Required**
 | string
 | Upload files to the following directories on the Rokt SFTP server:
- **Include Audience**: `/upload/custom-audience/include/AdvertiserDatabase/filename.csv`
- **Exclude Audience**: `/upload/custom-audience/exclude/AdvertiserDatabase/filename.csv`
- **Conversions**: `/upload/conversions/filename.csv`

 |
| Rename file after upload finish
**Required**
 | string
 | If selected, the file is uploaded to the SFTP with a suffix `.tmp`, and the suffix will be removed after the data transfer is completed. Some data integration tools try to detect a file's existence to trigger their own task. This option is useful for such cases.
 |
| Format
**Required**
 | string
 | - `csv` - comma separated (default)
- `tsv` - tab separated

 |
| Encoders
**Required**
 | string
 | - `None` - no encoder is applied

 |
| Header line?
**Required**
 | string
 | - No

 |
| Delimiter
**Required**
 | string
 | The delimiter character:
- `Default` - according to the selected Format

 |
| Quote policy
*Optional*
 | string
 | The policy for a quote:
- `ALL`
- `MINIMAL`: Add the quote character to only fields which contain delimiter, quote, or any of the end of line characters
- `NONE`

 |
| Null string
**Required**
 | string
 | How null value of the result of the query displays:
- `Default` - according to the selected Format
- empty string
- `\N`
- `NULL`
- `null`

 |
| End-of-line character
**Required**
 | string
 | The EOL (end-of-line) character:
- `CRLF` (default)
- `LF`
- `CR`

 |
| Temp filesize threshold
**Required**
 | long
 | If the export data is bigger than this threshold, the upload is executed in batches with the batch size is the threshold itself. If the error `channel is broken` occurs, trying to reduce this figure might resolve the error.
 |


### (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.
![](/assets/image2021-1-15_17-28-51.f1b242f6ecc7666a0097fdf37edd1682786ec11ef80eff68c66f091bc405c371.0f87d8d4.png)
4. In the drop-down, select one of the following schedule options:
![](/assets/image2021-1-15_17-29-47.45289a1c99256f125f4d887e501e204ed61f02223fde0927af5f425a89ace0c0.0f87d8d4.png)
| Drop-down Value | Description |
|  --- | --- |
| Custom cron... | Review [Custom cron... details](#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

![](/assets/image2021-1-15_17-30-23.0f94a8aa5f75ea03e3fec0c25b0640cd59ee48d1804a83701e5f2372deae466c.0f87d8d4.png)

| **Cron Value** | **Description** |
|  --- | --- |
| `0 * * * *` | Run once an hour. |
| `0 0 * * *` | Run once a day at midnight. |
| `0 0 1 * *` | Run once a month at midnight on the morning of the first day of the month. |
| "" | Create a job that has no scheduled run time. |



```
 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- 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:

| Field Value | Example | Example Description |
|  --- | --- | --- |
| A single value, within the limits displayed above for each field. |  |  |
| A wildcard `'*'` to indicate no restriction based on the field. | `'0 0 1 * *'` | Configures the schedule to run at midnight (00:00) on the first day of each month. |
| A range `'2-5'`, indicating the range of accepted values for the field. | `'0 0 1-10 * *'` | Configures the schedule to run at midnight (00:00) on the first 10 days of each month. |
| A list of comma-separated values `'2,3,4,5'`, indicating the list of accepted values for the field. | `0 0 1,11,21 * *'` | Configures the schedule to run at midnight (00:00) every 1st, 11th, and 21st day of each month. |
| A periodicity indicator `'*/5'` to express how often based on the field's valid range of values a schedule is allowed to run. | `'30 */2 1 * *'` | Configures the schedule to run on the 1st of every month, every 2 hours starting at 00:30. `'0 0 */5 * *'` configures the schedule to run at midnight (00:00) every 5 days starting on the 5th of each month. |
| A comma-separated list of any of the above except the `'*'` wildcard is also supported `'2,*/5,8-10'`. | `'0 0 5,*/10,25 * *'` | Configures the schedule to run at midnight (00:00) every 5th, 10th, 20th, and 25th day of each month. |


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.

Scheduled jobs that continuously fail due to configuration errors may be disabled on the system side after several notifications.

(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.


![](/assets/ouput.b2c7f1d909c4f98ed10f5300df858a4b19f71a3b0834df952f5fb24018a5ea78.8ebdf569.png)

- 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 Columns**to 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.


1. Set a **Schedule**.


![](/assets/snippet-output-connector-on-audience-studio-2024-08-28.a99525173709da1eb537f839019fa7876ffae95045154c8f2941b030022f792c.8ebdf569.png)

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


1. Select **Create**.


If you need to create an activation for a batch journey, review [Creating a Batch Journey Activation](/products/customer-data-platform/journey-orchestration/batch/creating-a-batch-journey-activation).

## (Optional) Export Integration Using the CLI

The [TD Toolbelt](https://toolbelt.treasuredata.com/) can trigger exporting the Query Result to SFTP from the CLI. You need to specify the parameters for the export job using the --result option of the td query command. For more information, refer to [Querying and Importing Data to Treasure Data from the Command Line](https://docs.treasuredata.com/smart/project-product-documentation/querying-and-importing-data-to-treasure-data-from-the-command-line).

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

Authentication using user & password


```json
{
  "type": "sftp_v2",
  "host": "IP or host of SFTP server",
  "port": 22,
  "path_prefix": "/upload/2024Aug29/TC01.csv",
  "temp_file_threshold": 1024,
  "timeout": 600,
  "user_directory_is_root": false,
  "rename_file_after_upload": true,
  "auth_method": "password",
  "username": "login user",
  "password": "password of user when auth_method is password"
}
```

Authentication using public/private key-pair


```json
{
  "type": "sftp_v2",
  "host": "IP or host of SFTP server",
  "port": 22,
  "path_prefix": "/upload/2024Aug29/TC01.csv",
  "temp_file_threshold": 1024,
  "timeout": 600,
  "user_directory_is_root": false,
  "rename_file_after_upload": true,
  "auth_method": "key_pair",
  "secret_key_file": "Content of private key file",
  "secret_key_passphrase": "td@123"
}
```

### CLI Parameters

| Name  | Description  | Value  | Default Value  | Required  |
|  --- | --- | --- | --- | --- |
| type | Type must be **sftp_v2** | String | NULL | YES |
| host | The address of the SFTP server specified as an IP address or domain name- 192.168.1.1
- eu-west-1.sftpcloud.io

 | String | NULL | YES |
| port | The port for the connection with the SFTP Server | Number | 22 | NO |
| user_directory_is_root | On some servers, users will have a home directory which is their root directory. For example, a user named john could have root directory name /home/john. If that user wanted to upload a file to a directory named /home/john/day1/my_data.csv, they would have two options:- set user_directory_is_root to true and use this path_prefix: /day1/my_data.csv
- set user_directory_is_root to false and use this path_prefix: /home/john/day1/my_data.csv

 | String | False | NO |
| path_prefix | The path where you want to upload the file on the SFTP server. The value of path_prefix depends on whether user_directory_is_root is true or false. | String | NULL | YES |
| rename_file_after_upload | Determines whether the file is renamed after the upload completes | Boolean | False | NO |
| temp_file_threshold | The size of the temporary file to be used during export. When the temporary file size is reached, the integration reads and writes the data from that file to the remote file and the deletes the temporary file. | Number | 5,368,709,120 (5 Gb) | NO |
| auth_method | Determines which authentication type will be used to authenticate with SFTP server:- Username/password
- Public/Private key pair

 | Supported values:- password
- key_pair

 | key_pair | YES |
| username | The username that is used to authenticate | String | NULL | YES |
| password | The password that is use to authenticate | String | NULL | YES, when auth_method is password |
| secret_key_file
 | The private key file that is used to authenticate. The content of the file should be formatted as one line.
Example

```bash
td ... --result '{"type":"sftp_v2", "secret_key_file": "-----BEGIN OPENSSH PRIVATE KEY-----\nline1\nline2\nline3\n-----END OPENSSH PRIVATE KEY-----\n\n"}'
```
Content of private key file before formatting:

```
-----BEGIN OPENSSH PRIVATE KEY-----
line1
line2
line3
-----END OPENSSH PRIVATE KEY-----
```
After formatting

```
-----BEGIN OPENSSH PRIVATE KEY-----line1line2line3-----END OPENSSH PRIVATE KEY-----
```
 | String
 | NULL
 | YES, when auth_method is key_pair
 |
| secret_key_passphrase | If the private key was generated with a password, input that password here. | String | NULL | NO |
| sequence_format | The suffix name of file being uploaded. For example, "%03d.%02d" | String | Blank | NO |
| format | The output format of file being uploaded file | Supported values:- csv
- tsv

 | csv | NO |
| encoders | Specifies the encoder's type of the output | Supported values:- ""
- gz
- bzip2
- encrypt_pgp

 | "" | NO |
| public_key | The public key to use for encryption | String |  |  |
| key_identifier | Specifies the Key ID of the encryption subkey used to secure the file. The master key is excluded from the encryption process. (string, required) | String |  |  |
| amor | Use ASCII armor for the encrypted output (boolean) | Boolean |  |  |
| compression_type
 | The compression type determines whether to compress the data before encrypting it.
 | Supported values
- gzip
- bzip2
- none
- zip_builtin
- zlip_builtin
- bzip2_builtin

**Note: Please ensure that you compress your file before encrypting and uploading. When you decrypt it, the file will return to a compressed format such as .gz or .bz2.**
 |  |  |
| delimiter | Column delimiter | Supported values:- ","
- "\t"
- "tab"
- "|"

 | "," | NO |
| quote_policy
 | The policy for handing quotes
 | Supported values:
- ALL. If selected, all values are enclosed by double quotes ("").
- MINIMAL. If selected, any value that contains an embedded quote (") is presented with a consecutive pair of quotes ("").
- NONE. If selected, no escape for embedded quote is applied.

Example Code Policy ALL
Config:

```
quote_policy: ALL,
quote: "'",
```
Output

```
'id'|'column01'|'column02'|'column03'|'column04'|'column05'
'1'|'data01'|'data02'|'data03'|'data04'|'data05'
```
Example Code Policy MINIMAL
Config:

```
quote_policy: MINIMAL,
quote: "'",
```
Output

```
id|column01|column02|column03|column04|column05
1|data01|data02|data03|data04|data05
```
 |  |  |
| quote
 | Determines whether quoting will use single or double quotes.
 | Single Quote
Config

```
quote_policy: ALL,
quote: "'",
```
Output

```
'id'|'column01'|'column02'
'1'|'data01'|'data02'
```
Double Quote
Config

```
quote_policy: ALL,
quote: "\"",
```
Output

```
"id"|"column01"|"column02"
"1"|"data01"|"data02"
```
 |  |  |
| null_string | Determines the default value for null column. | Supported values:- ""
- \N
- NULL

 | "" |  |
| newline | Determines how new lines are started in CSV files. | Supported values:- `CRLF`
- `LF`
- `CR`

 | `CRLF` |  |


### Example Usage

1. **Using password authentication**

```bash
td --database your_db --wait "SELECT email FROM (VALUES ('test01@test.com')) tbl(email)" \
--type presto \
--result '{"type":"sftp_v2","host":"your_ip","port": 22,"auth_method":"password","username":"user_name","password":"your_pass", "user_directory_is_root": true, "rename_file_after_upload": true,"path_prefix":"/sftp/2024aug/test.csv"}'
```
2. **Using password authentication and data compression**

```bash
td --database your_db --wait "SELECT email FROM (VALUES ('test01@test.com')) tbl(email)" \
--type presto \
--result '{"type":"sftp_v2","host":"your_ip","port": 22,"auth_method":"password","username":"user_name","password":"password","user_directory_is_root":true,"path_prefix":"/sftp/2024aug/test.csv","rename_file_after_upload":true,"format": "csv", "compression": "gz","header_line":true,"quote_policy":"ALL","delimiter":"\t","null_string":"","newline":"CRLF","temp_file_threshold":0,"sequence_format":".%01d%01d"}'
```
3. **Using Public/Private key authentication with password phrase**
Private key file content (password phrase is `123`):

```
-----BEGIN OPENSSH PRIVATE KEY-----
line1
line2
line3
-----END OPENSSH PRIVATE KEY-----
```
Format for CLI:

```
-----BEGIN OPENSSH PRIVATE KEY-----\nline1\nline2\nline3\n-----END OPENSSH PRIVATE KEY-----\n\n
```
The CLI command:

```bash
td --database your_db --wait "SELECT email FROM (VALUES ('test01@test.com')) tbl(email)" \
--type presto \
--result '{"type":"sftp_v2","host":"your_ip","port": 22,"auth_method":"key_pair","username":"user_name", "path_prefix": "/sftp/2024aug/test.csv","sequence_format":"","max_connection_retry":5,"secret_key_passphrase":"123","timeout":600,"secret_key_file":"-----BEGIN OPENSSH PRIVATE KEY-----\nline1\nline2\nline3\n-----END OPENSSH PRIVATE KEY-----\n\n"}'
```
4. **Create the new customer**

```bash
td --database luan_db --wait "SELECT customer_list_id,first_name,last_name,birthday,company_name,email,fax,gender,job_title,phone_business,phone_home,phone_mobile,second_name,credentials FROM (VALUES ('site_1','fname_201','lname_1','1990-05-12','Test Company',
```
5. **Using the encryption encoder**

```bash
td query -d luan_db -w "select * from luan_db.sfcc_500k" -T presto --result '{
  "type": "sftp_v2",
  "host": "your host server",
  "auth_method": "password",
  "username": "your user name",
  "password": "your password",
  "path_prefix": "cli/test_27_3_500K.csv.bz2.gpg",
  "file_ext": ".gpg",
  "rename_file_after_upload": false,
  "formatter": {
    "type": "csv",
    "quote_policy": "MINIMAL",
    "delimiter": ",",
    "null_string": "null",
    "newline": "\n"
  },
  "compression": "encrypt_pgp",
  "public_key": "your public key",
  "key_identifier": "your key identifier",
  "armor": true/false,
  "compression_type": "bzip2/gzip/none"
}'
```


### (Optional) Other considerations

Within Treasure Workflow, you can specify the use of this integration to export data. For sample workflows, view [Treasure Boxes](https://github.com/treasure-data/treasure-boxes/tree/master/td/sftp).

- The Result Export can be [scheduled](https://docs.treasuredata.com/articles/pd/scheduling-jobs-using-td-console) to upload data to a target destination periodically
- Most import and export integrations can be added to a TD Workflow to be involved in a more advanced data pipeline. Refer [here](/int/using-td-workflow-with-td-integrations) for more detailed information.


## 

## FAQ for the SFTP Data Connector

Q: I cannot connect to my SFTP server. What can I do?

A: Here are some things to check:

- Verify that your protocol is valid. If you intended to use *SFTP*, you can use this integration. If you intended to use *FTP*/*FTPS*, try to connect with the [FTP Server Import Integration](/int/ftp-server-import-integration).
- If you are using a firewall, check your accepted IP range and port. Server administrators sometimes change the default port number from TCP 22 for security reasons.
- Be sure that your private key has an *OpenSSH* format. Treasure Data does not support other formats like “PuTTY”.
- Treasure Data does not support the default format of the private key since [OpenSSH 7.8](https://www.openssh.com/releasenotes.md). Re-generate the key using '-m PEM' option.


Q: I cannot find my uploaded file on the SFTP server. What happened?

A: If your SFTP server does not support Append mode, the integration may not be able to update the file with the error "SFTP Exception: no such file."  For stability reasons, the integration uploads the file content in batches. Consequently, you will need to enable the Append mode on your SFTP server. If Append mode cannot be enabled on your SFTP server, you will need to set temp_file_threshold to 0 to bypass this feature.

Note: Please ensure that you compress your file before encrypting and uploading.

1. When you decrypt using non-built-in encryption, the file will return to a compressed format such as .gz or .bz2.
2. When you decrypt using built-in encryption, the file will return to raw data.