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. Amazon Capi Export

Amazon Capi Export

markdownView as Markdown

Create and manage data import and export jobs.

AmazonCapiExport: Create job

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

Create a AmazonCapiExport job

Sample Request
123456789101112131415161718192021222324252627282930313233343536373839404142
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "ad_storage_consent": "",
    "advertiser_id": "string",
    "audience_events": "enters_only",
    "conversion_type": "ADD_TO_SHOPPING_CART",
    "country_code": "string",
    "currency_code": "AED",
    "data_set_name": "string",
    "event_id": "string",
    "event_name": "string",
    "event_source": "ANDROID",
    "event_timestamp": "string",
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "segment_ids": [
      "string"
    ],
    "units_sold": "string",
    "user_data_consent": "",
    "value": "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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
{
  "_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": {
      "ad_storage_consent": "",
      "advertiser_id": "string",
      "audience_events": "enters_only",
      "conversion_type": "ADD_TO_SHOPPING_CART",
      "country_code": "string",
      "currency_code": "AED",
      "data_set_name": "string",
      "event_id": "string",
      "event_name": "string",
      "event_source": "ANDROID",
      "event_timestamp": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "segment_ids": [
        "string"
      ],
      "units_sold": "string",
      "user_data_consent": "",
      "value": "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
}

AmazonCapiExport: Get job

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

Get the summary of a AmazonCapiExport job

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
{
  "_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": {
      "ad_storage_consent": "",
      "advertiser_id": "string",
      "audience_events": "enters_only",
      "conversion_type": "ADD_TO_SHOPPING_CART",
      "country_code": "string",
      "currency_code": "AED",
      "data_set_name": "string",
      "event_id": "string",
      "event_name": "string",
      "event_source": "ANDROID",
      "event_timestamp": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "segment_ids": [
        "string"
      ],
      "units_sold": "string",
      "user_data_consent": "",
      "value": "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
}

AmazonCapiExport: Update job

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

Update a AmazonCapiExport job

Sample Request
123456789101112131415161718192021222324252627282930313233343536373839404142
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "ad_storage_consent": "",
    "advertiser_id": "string",
    "audience_events": "enters_only",
    "conversion_type": "ADD_TO_SHOPPING_CART",
    "country_code": "string",
    "currency_code": "AED",
    "data_set_name": "string",
    "event_id": "string",
    "event_name": "string",
    "event_source": "ANDROID",
    "event_timestamp": "string",
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "segment_ids": [
      "string"
    ],
    "units_sold": "string",
    "user_data_consent": "",
    "value": "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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
{
  "_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": {
      "ad_storage_consent": "",
      "advertiser_id": "string",
      "audience_events": "enters_only",
      "conversion_type": "ADD_TO_SHOPPING_CART",
      "country_code": "string",
      "currency_code": "AED",
      "data_set_name": "string",
      "event_id": "string",
      "event_name": "string",
      "event_source": "ANDROID",
      "event_timestamp": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "segment_ids": [
        "string"
      ],
      "units_sold": "string",
      "user_data_consent": "",
      "value": "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.ad_storage_consentoptionalstring

Amazon ad storage consent status. Required for EU countries.

One of: , GRANTED, DENIED

config.advertiser_idrequiredstring

Enter your Amazon Ads Advertiser ID (DSP Advertiser ID)

config.audience_eventsoptionalstring

Select which type of audience trigger events to send. By default both enters and exits will be sent.

One of: enters_only, exits_only

config.conversion_typerequiredstring

Select the Amazon conversion type for this event

One of: ADD_TO_SHOPPING_CART, APPLICATION, CHECKOUT, CONTACT, LEAD, OFF_AMAZON_PURCHASES, MOBILE_APP_FIRST_START, PAGE_VIEW, SEARCH, SIGN_UP, SUBSCRIBE, OTHER

config.country_codeoptionalstring

Select the 2 letter country code (ISO 3166-1 alpha-2). Required by Amazon for compliance.

config.currency_codeoptionalstring

Enter currency code, three letter code in ISO-4217 format. Only for OFF_AMAZON_PURCHASES. If not provided, "USD" will be used as default

One of: AED, AUD, BRL, CAD, CNY, EUR, GBP, INR, JPY, MXN, SAR, SEK, SGD, TRY, USD

config.data_set_nameoptionalstring

Optional: Event Dataset Name for organizing conversion definitions

config.event_idoptionalstring

Select the Lytics user field that contains a unique event ID for deduplication

config.event_nameoptionalstring

Enter the name for the event. If not provided, events will be sent with **Lytics Audiences** name

config.event_sourceoptionalstring

Select the platform from which the event was sourced

One of: ANDROID, FIRE_TV, IOS, MEASUREMENT_ATTRIBUTION_PARTNER, OFFLINE, WEBSITE

config.event_timestampoptionalstring

Select the Lytics user field that contains the timestamp of the event. The timestamp must not be older than 21 days. If left empty, current timestamp will be used

config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user field change event will be sent to the Amazon Ads API.

config.identifier_mappingrequiredobject[]

Map Lytics user fields to Amazon Ads PII. We will hash (SHA256) the identifiers before we send them to Amazon Ads. You can also select a field that is already hashed.

config.segment_idsrequiredstring[]

Select the Lytics audiences that contains the users to export

config.units_soldoptionalstring

Select the Lytics user field that contains the number of units sold. Only for OFF_AMAZON_PURCHASES

config.user_data_consentoptionalstring

Amazon user data consent status. Required for EU countries.

One of: , GRANTED, DENIED

config.valueoptionalstring

Select the Lytics user field that contains the value of the event

config.withbackfilloptionalboolean

Select this to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they leave or enter 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.ad_storage_consentoptionalstring

Amazon ad storage consent status. Required for EU countries.

One of: , GRANTED, DENIED

config.advertiser_idrequiredstring

Enter your Amazon Ads Advertiser ID (DSP Advertiser ID)

config.audience_eventsoptionalstring

Select which type of audience trigger events to send. By default both enters and exits will be sent.

One of: enters_only, exits_only

config.conversion_typerequiredstring

Select the Amazon conversion type for this event

One of: ADD_TO_SHOPPING_CART, APPLICATION, CHECKOUT, CONTACT, LEAD, OFF_AMAZON_PURCHASES, MOBILE_APP_FIRST_START, PAGE_VIEW, SEARCH, SIGN_UP, SUBSCRIBE, OTHER

config.country_codeoptionalstring

Select the 2 letter country code (ISO 3166-1 alpha-2). Required by Amazon for compliance.

config.currency_codeoptionalstring

Enter currency code, three letter code in ISO-4217 format. Only for OFF_AMAZON_PURCHASES. If not provided, "USD" will be used as default

One of: AED, AUD, BRL, CAD, CNY, EUR, GBP, INR, JPY, MXN, SAR, SEK, SGD, TRY, USD

config.data_set_nameoptionalstring

Optional: Event Dataset Name for organizing conversion definitions

config.event_idoptionalstring

Select the Lytics user field that contains a unique event ID for deduplication

config.event_nameoptionalstring

Enter the name for the event. If not provided, events will be sent with **Lytics Audiences** name

config.event_sourceoptionalstring

Select the platform from which the event was sourced

One of: ANDROID, FIRE_TV, IOS, MEASUREMENT_ATTRIBUTION_PARTNER, OFFLINE, WEBSITE

config.event_timestampoptionalstring

Select the Lytics user field that contains the timestamp of the event. The timestamp must not be older than 21 days. If left empty, current timestamp will be used

config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user field change event will be sent to the Amazon Ads API.

config.identifier_mappingrequiredobject[]

Map Lytics user fields to Amazon Ads PII. We will hash (SHA256) the identifiers before we send them to Amazon Ads. You can also select a field that is already hashed.

config.segment_idsrequiredstring[]

Select the Lytics audiences that contains the users to export

config.units_soldoptionalstring

Select the Lytics user field that contains the number of units sold. Only for OFF_AMAZON_PURCHASES

config.user_data_consentoptionalstring

Amazon user data consent status. Required for EU countries.

One of: , GRANTED, DENIED

config.valueoptionalstring

Select the Lytics user field that contains the value of the event

config.withbackfilloptionalboolean

Select this to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they leave or enter 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