Last updated Oct 24, 2023

Export transactions

To begin the API setup, Rokt requires a few pieces of information.

The following details should be sent to your account manager:

1. Full API documentation on how to create subscribers in your system.
2. Technical contact details to help troubleshoot setup queries.
3. Endpoints for any relevant environments (production, testing, staging, etc.).
4. Method (e.g., GET, POST, PUT)
5. Authentication (if any)
6. Request body encoding (e.g., JSON, XML, URL Encoded)
7. Required API parameters (Learn about what attributes Rokt can share.)
8. Expected API responses to help Rokt accurately categorize leads delivered successfully versus those that were rejected.

Set up the API connection

1. Log-on to my.rokt.com

2. Navigate to your account.

3. Click Integrations.

4. Click Connections.

5. Click Add connection.

6. Under Transactions, select API.

   1. Give your connection a name.

      

   2. Enter the endpoint for your connection.

      

   3. Enter all required information under Authorization, Headers, and Body.

      

   4. Enter all of your Response handling rules.

      

   5. Once your API connection is set up (endpoint, authorization, headers, body, and response handling), click Settings.

      

   6. Edit the test settings according to your test criteria.

      

   7. Click Save.

   8. Click Test.

      

   9. Check your test result.

   10. Repeat tests until you've achieved your desired outcomes.

Link placements to your API connection

1. Log-on to my.rokt.com

2. Navigate to your account.

3. Click Integrations.

4. Click Connections.

5. Select Real-time from the left drop-down menu and Transactions from the right drop-down menu.

6. Expand the connection that you want to link your placements to.

   

7. Click Show unlinked.

   

8. Click Link for All Placements.

   

9. All placements are now linked to your connection.

   

Unlink placements from your API connection

1. Log-on to my.rokt.com

2. Navigate to your account.

3. Click Integrations.

4. Click Connections.

5. elect Real-time from the left dropdown menu and Transactions from the right dropdown menu.

6. Expand the connection that you want to unlink your placements from.

   

7. Click Unlink to unlink all placements.

   

8. All placements are unlinked.

Scheduled deliveries

Establishing a connection from a host computer (e.g., your laptop) to a secure FTP server requires third-party client software. This tutorial suggests the popular and free client FileZilla which is available for Windows, Mac, and Linux operating systems.

1. In your browser, navigate to https://filezilla-project.org/ and click Download FileZilla Client.
2. Install FileZilla on your computer. If you already have FileZilla installed, ensure you are running the latest version.
3. 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."
4. Download the attached file and unzip the encrypted file using the password provided in a second email "Email for password for file with instructions."
5. The encrypted file you have just unzipped contains a .pem file which is your key file to access Rokt's SFTP folder.

note

The following steps are the same for Windows, Mac, and Linux operating systems and are based on the latest version of FileZilla.

6. Open FileZilla and navigate to File > Site Manager

7. On the left, click New Site and fill in the following:

• Protocol: SFTP – SSH File Transfer Protocol

• Host: ftp.rokt.com

• Port: 22

• Key file: Browse to your local key file (.pem) and select it from your local drive (see image below).

  

8. Click Connect. You should be connected and able see your accessible folders to upload files.

Secure File Transfer Protocol (SFTP) connections automate your data deliveries and require little effort to set up. All you need are your SFTP credentials, and you’re ready to go!

After setting up an SFTP connection, you receive an email with a CSV file containing all of your transaction data at any frequency you prefer.

Rokt's SFTP connection

Before you begin

If you don't yet have access to the Rokt SFTP, reach out to your account manager.

Make sure you have the following information handy:

1. Delivery frequency—how often and at what times transactions will be uploaded into the SFTP server.
2. Required parameters—the most common being email, first name, last name, source, and state. For all available attributes, see Transaction metadata.

File path and requirements

Transaction data files are placed within the following file path:

File path	Purpose
/downloads	Download transaction data provided by Rokt

note

Transaction files are automatically deleted from this folder after 14 days.

Use your own FTP connection

1. Log-on to my.rokt.com

2. Navigate to your account.

3. Click Integrations.

4. Click Connections.

5. Click Add connection.

6. Under Transactions, click FTP.

7. Select a template for this connection, then give your connection a name.

   

8. Enter the directory and file name.

   

9. Enter your FTP server host details and port.

   

10. Select your desired FTP method.

    

11. Enter the username and password, or enter the username and upload your key file.

    

12. Select your schedule and click Save.

    

13. Your connection has been created.

Disable an FTP connection

1. Log-on to my.rokt.com

2. Navigate to your account.

3. Click Integrations.

4. Click Connections.

5. Select Scheduled from the left dropdown menu and Transactions from the right dropdown menu.

   

6. Click Pause.

   

7. Your email connection is disabled.

   

8. You can reverse these steps to enable your connection.

Manual export

However you like to have your transaction data delivered to you, all of your data is always accessible on the Rokt platform by going to Transactions > Customer Data > Export.

If something goes wrong, such as an API failure or an email being deleted, don’t worry! You can always log in to Rokt and download all of your transaction data at any time.

Rokt offers downloadable data in CSV format. To download:

1. Log-on to my.rokt.com

2. Navigate to your account.

3. Click Transactions.

4. Click Customer Data.

5. Choose the placement that you want to view transaction data for.

6. Adjust the date range in the top navigation bar.

7. Click Export.

8. Your export will immediately begin downloading to your computer. Depending on the number of records in the report, it may take a little while to complete. You should be able to open the CSV files into most common spreadsheet applications.

note

A maximum of 100,000 records can be downloaded at a time.

Customize export data fields

The export uses a default template containing the key fields for your transactions. In needed, you can customize what data you export by adding, removing, and reordering the columns.

1. Log-on to my.rokt.com

2. Navigate to your account.

3. Click Transactions.

4. Click Customer Data.

5. From the Template dropdown, select Create new template.

   

6. On the screen that appears, use the drop-down menu to add or remove data fields.

   

7. Update the order of columns in the export file by dragging and dropping the fields.

   

8. Click Save as and enter a template name, if you want to use this template for future exports.

   

9. Click Export to download your data to a CSV file.