Rokt Documentation
  • Documentation
  • User Guide
  • SDK
  • API
  • Third-Party Integrations
  • Help

›Transactions

Overview

  • Introduction

Getting started

  • Glossary

Administration

  • Account settings
  • User management
  • Billing - Rokt Acquire

    • Billing & payment for campaigns
    • Invoicing & payment for monetization
    • Financial responsibility assignment
    • Agency commission setup

    Billing - Rokt Commerce

    • Billing & payment for campaigns
    • Invoicing & Payment for monetization

Campaigns

  • Creating campaigns
  • Editing campaigns
  • Pausing campaigns
  • Campaign status guide
  • Campaigns best practices
  • Audiences

    • Creating audiences
    • Editing audiences
    • Pausing audiences
    • Bid price
    • Attribute targeting

    Creatives

    • Building creatives
    • Editing creatives
    • Pausing creatives
    • Linking creatives to audiences
    • Effective creative copywriting

    Nurture

    • Creating Nurture Journeys
    • Creating emails

    Coupons

    • Sending coupon codes
    • Adding coupon codes
    • Replacing coupon codes

    Campaign policies

    • Policy overview
    • Quality consent
    • Transparency accuracy
    • Editorial requirements
    • Prohibited content
    • Social & ethical appropriateness
    • Compliance industry codes & regulations
    • Target audiences & restricted campaign content

Transaction

    Pages

    • Pages

    Placements

    • Placements

    Controls

    • Campaign & marketplace controls
    • Brand & vertical block rules
    • Minimum Quality Score setup
    • Advertiser vertical & sub-vertical breakdown

    Audiences

    • Audience targeting

Rokt Calendar

  • Overview
  • Integration guide
  • UTM tracking

Reporting & measurement

    Performance - Rokt Acquire

    • Conversion attribution
    • Campaign performance graphs

    Performance - Rokt Commerce

    • Transactions Dashboard

Data integrations

    Events

    • Import via Rokt SFTP
    • Import via measurement providers
    • Manual import

    Referrals

    • Overview
    • Export via API
    • Export via Rokt SFTP
    • Export via client SFTP
    • Export via email
    • Export via Mailchimp
    • Export via Sailthru
    • Export via Zapier
    • Manual export

    Transactions

    • Overview
    • Export via API
    • Export via Rokt SFTP
    • Export via client SFTP
    • Export via email
    • Manual export

    Custom audiences

    • Overview
    • Import via Rokt SFTP
    • Import via CSV (email)
    • Import via CSV (ZIP code)
    • Import via Mailchimp
    • Import via Zapier

    Unsubscribes

    • Export via API

    Advanced guides

    • Rokt SFTP setup
    • Rokt Tracking ID for attribution
    • Tracking application installs
    • Rokt IP addresses
    • Hashing sensitive data
    • Custom field management
    • Managing templates
    • Google Tag Manager integration
Edit

Transaction export via API

API setups can range from easy plug-and-play integrations, to advanced two-phase integrations with custom field mapping. Regardless, given the intricacies of One Platform and the sensitivity of these integrations, transactions API setups should always be completed by the operations team.

Before you begin

Be sure you have all the required API setup information first including the relevant environment endpoints, authentication method, and any required parameters.

Setting up the API connection

  1. Navigate to your account in One Platform.

  2. From the left navigation, click Connections.

    Transaction Export via API

  3. Click Add connection.

    Transaction Export via API

  4. Under Transactions, select API.

    Transaction Export via API

  5. Give your connection a name.

    Transaction Export via API

  6. Enter the endpoint for your connection.

    Transaction Export via API

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

    Transaction Export via API

  8. Enter all your Response handling rules.

    Transaction Export via API

Testing your real-time connection

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

    Transaction Export via API

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

    Transaction Export via API

  3. Click Save.

  4. Click Test.

    Transaction Export via API

  5. Check your test result.

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

Linking placements to your API connection

  1. From the Connections page, select Real-time and Transactions from the dropdown.

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

    Transaction Export via API

  3. Click Show unlinked.

    Transaction Export via API

  4. Click Link for All Placements.

    Transaction Export via API

  5. All placements are now linked to your connection.

    Transaction Export via API

Unlinking placements from your API connection

  1. From the Connections page, select Real-time and Transactions from the dropdown.

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

    Transaction Export via API

  3. Click Unlink to unlink all placements.

    Transaction Export via API

  4. All placements are unlinked.

← OverviewExport via Rokt SFTP →
  • Before you begin
  • Setting up the API connection
  • Testing your real-time connection
  • Linking placements to your API connection
  • Unlinking placements from your API connection
RESOURCES
DocumentationUser GuideSDKAPIIntegration PartnersHelp
COMPANY
About UsContact UsCareersEngineering Blog
Rokt Documentation
Copyright © Rokt 2021 - All Rights Reserved