Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. Jobs
  5. Thetradedesk Capi Export

Thetradedesk Capi Export

markdownView as Markdown

Create and manage data import and export jobs.

ThetradedeskCapiExport: Create job

POSThttps://api.lytics.io/v2/job/thetradedesk-capi-export

Create a ThetradedeskCapiExport job

Sample Request
1234567891011121314151617181920212223242526272829303132333435363738394041424344
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "advertiser_id": "string",
    "audience_events": "enters_only",
    "custom_fields_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "event_name": "string",
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "item_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "merchant_id": "string",
    "pixel_id": "string",
    "referrer_url_field": "string",
    "segment_id": "string",
    "withbackfill": true
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|201 Created
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "advertiser_id": "string",
      "audience_events": "enters_only",
      "custom_fields_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "event_name": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "item_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "merchant_id": "string",
      "pixel_id": "string",
      "referrer_url_field": "string",
      "segment_id": "string",
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

ThetradedeskCapiExport: Get job

GEThttps://api.lytics.io/v2/job/thetradedesk-capi-export/{id}

Get the summary of a ThetradedeskCapiExport job

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "advertiser_id": "string",
      "audience_events": "enters_only",
      "custom_fields_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "event_name": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "item_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "merchant_id": "string",
      "pixel_id": "string",
      "referrer_url_field": "string",
      "segment_id": "string",
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

ThetradedeskCapiExport: Update job

PUThttps://api.lytics.io/v2/job/thetradedesk-capi-export/{id}

Update a ThetradedeskCapiExport job

Sample Request
1234567891011121314151617181920212223242526272829303132333435363738394041424344
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "advertiser_id": "string",
    "audience_events": "enters_only",
    "custom_fields_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "event_name": "string",
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "item_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "merchant_id": "string",
    "pixel_id": "string",
    "referrer_url_field": "string",
    "segment_id": "string",
    "withbackfill": true
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "advertiser_id": "string",
      "audience_events": "enters_only",
      "custom_fields_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "event_name": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "item_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "merchant_id": "string",
      "pixel_id": "string",
      "referrer_url_field": "string",
      "segment_id": "string",
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}
Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.advertiser_idoptionalstring

Enter your Trade Desk Advertiser ID. Required when sending page view events. Can be omitted when sending only user-interaction events.

config.audience_eventsoptionalstring

Select which audience trigger events to send. By default both enters and exits are sent.

One of: enters_only, exits_only

config.custom_fields_mappingoptionalobject[]

Optional. Map Lytics user fields to The Trade Desk custom fields td1..td10 for additional metadata (e.g. promo codes).

config.event_nameoptionalstring

Enter the name of the user-interaction event (e.g. addtocart, purchase). Required when sending user-interaction events. Leave empty for page view events.

config.field_changesoptionalstring[]

Select up to 75 user fields. If any selected field changes for a user in the exported audience, the user will be sent to the Trade Desk Conversion API.

config.identifier_mappingrequiredobject[]

Map a Lytics user field to one of the Trade Desk identifier types (UID2, EUID, TDID, IDFA, AAID, NAID, DAID, IDL). At least one mapping is required. Identifiers are passed through as-is; UID2/EUID must be tokens (not raw).

config.item_mappingoptionalobject[]

Optional. Map Lytics user fields to The Trade Desk item-level fields (name, qty, price, cat, item_brand) for user-interaction events.

config.merchant_idoptionalstring

Enter your Trade Desk Merchant ID. Required when sending user-interaction events with a product catalog. Can be omitted when sending only page view events.

config.pixel_idrequiredstring

Enter the universal pixel ID (for page views) or the event tracking tag ID (for user interactions) configured in The Trade Desk.

config.referrer_url_fieldoptionalstring

Select the Lytics user field that contains the page URL. Required when sending page view events.

config.segment_idrequiredstring

Select the Lytics audience that contains the users to export

config.withbackfilloptionalboolean

Select to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they enter or leave the audience.

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.advertiser_idoptionalstring

Enter your Trade Desk Advertiser ID. Required when sending page view events. Can be omitted when sending only user-interaction events.

config.audience_eventsoptionalstring

Select which audience trigger events to send. By default both enters and exits are sent.

One of: enters_only, exits_only

config.custom_fields_mappingoptionalobject[]

Optional. Map Lytics user fields to The Trade Desk custom fields td1..td10 for additional metadata (e.g. promo codes).

config.event_nameoptionalstring

Enter the name of the user-interaction event (e.g. addtocart, purchase). Required when sending user-interaction events. Leave empty for page view events.

config.field_changesoptionalstring[]

Select up to 75 user fields. If any selected field changes for a user in the exported audience, the user will be sent to the Trade Desk Conversion API.

config.identifier_mappingrequiredobject[]

Map a Lytics user field to one of the Trade Desk identifier types (UID2, EUID, TDID, IDFA, AAID, NAID, DAID, IDL). At least one mapping is required. Identifiers are passed through as-is; UID2/EUID must be tokens (not raw).

config.item_mappingoptionalobject[]

Optional. Map Lytics user fields to The Trade Desk item-level fields (name, qty, price, cat, item_brand) for user-interaction events.

config.merchant_idoptionalstring

Enter your Trade Desk Merchant ID. Required when sending user-interaction events with a product catalog. Can be omitted when sending only page view events.

config.pixel_idrequiredstring

Enter the universal pixel ID (for page views) or the event tracking tag ID (for user interactions) configured in The Trade Desk.

config.referrer_url_fieldoptionalstring

Select the Lytics user field that contains the page URL. Required when sending page view events.

config.segment_idrequiredstring

Select the Lytics audience that contains the users to export

config.withbackfilloptionalboolean

Select to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they enter or leave the audience.

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring