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

Reddit Capi Export

markdownView as Markdown

Create and manage data import and export jobs.

RedditCapiExport: Create job

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

Create a RedditCapiExport job

Sample Request
123456789101112131415161718192021222324252627282930313233343536373839
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "action_source": "WEBSITE",
    "ad_account_id": "string",
    "audience_events": "enters_only",
    "click_id": "string",
    "conversion_id": "string",
    "country_code": "string",
    "currency_code": "AED",
    "event_timestamp": "string",
    "event_type": "string",
    "field_changes": [
      "string"
    ],
    "item_count": "string",
    "segment_ids": [
      "string"
    ],
    "user_data_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
{
  "_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": {
      "action_source": "WEBSITE",
      "ad_account_id": "string",
      "audience_events": "enters_only",
      "click_id": "string",
      "conversion_id": "string",
      "country_code": "string",
      "currency_code": "AED",
      "event_timestamp": "string",
      "event_type": "string",
      "field_changes": [
        "string"
      ],
      "item_count": "string",
      "segment_ids": [
        "string"
      ],
      "user_data_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "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
}

RedditCapiExport: Get job

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

Get the summary of a RedditCapiExport job

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
{
  "_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": {
      "action_source": "WEBSITE",
      "ad_account_id": "string",
      "audience_events": "enters_only",
      "click_id": "string",
      "conversion_id": "string",
      "country_code": "string",
      "currency_code": "AED",
      "event_timestamp": "string",
      "event_type": "string",
      "field_changes": [
        "string"
      ],
      "item_count": "string",
      "segment_ids": [
        "string"
      ],
      "user_data_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "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
}

RedditCapiExport: Update job

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

Update a RedditCapiExport job

Sample Request
123456789101112131415161718192021222324252627282930313233343536373839
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "action_source": "WEBSITE",
    "ad_account_id": "string",
    "audience_events": "enters_only",
    "click_id": "string",
    "conversion_id": "string",
    "country_code": "string",
    "currency_code": "AED",
    "event_timestamp": "string",
    "event_type": "string",
    "field_changes": [
      "string"
    ],
    "item_count": "string",
    "segment_ids": [
      "string"
    ],
    "user_data_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
{
  "_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": {
      "action_source": "WEBSITE",
      "ad_account_id": "string",
      "audience_events": "enters_only",
      "click_id": "string",
      "conversion_id": "string",
      "country_code": "string",
      "currency_code": "AED",
      "event_timestamp": "string",
      "event_type": "string",
      "field_changes": [
        "string"
      ],
      "item_count": "string",
      "segment_ids": [
        "string"
      ],
      "user_data_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "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.action_sourceoptionalstring

Select where the conversion event occurred (website, app, etc.). If not selected, this field will not be sent to Reddit.

One of: WEBSITE, APP, PHYSICAL_STORE, OTHER

config.ad_account_idrequiredstring

Enter your Reddit Ads Account ID

config.audience_eventsoptionalstring

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

One of: enters_only, exits_only

config.click_idoptionalstring

Select the Lytics user field that contains the Reddit click ID.

config.conversion_idoptionalstring

Select the Lytics user field that contains the conversion ID that will be used for deduplication in Reddit.

config.country_codeoptionalstring

Select the 2 letter country code where the users are located. If not provided, "US" will be used as default.

config.currency_codeoptionalstring

Select the currency code, three letter code in ISO-4217 format. 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.event_timestampoptionalstring

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

config.event_typeoptionalstring

Select the type of the conversion event. If not selected, the event will be sent with **lytics_audiences}** custom name.

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 Reddit API.

config.item_countoptionalstring

Select the Lytics user field that contains the number of item sold.

config.segment_idsrequiredstring[]

Select the Lytics audiences that contains the users to export

config.user_data_mappingoptionalobject[]

Map Lytics user fields to Reddit User Data. Atleast one user data or click id must be provided.

config.valueoptionalstring

Select the Lytics user field that contains monetary 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.action_sourceoptionalstring

Select where the conversion event occurred (website, app, etc.). If not selected, this field will not be sent to Reddit.

One of: WEBSITE, APP, PHYSICAL_STORE, OTHER

config.ad_account_idrequiredstring

Enter your Reddit Ads Account ID

config.audience_eventsoptionalstring

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

One of: enters_only, exits_only

config.click_idoptionalstring

Select the Lytics user field that contains the Reddit click ID.

config.conversion_idoptionalstring

Select the Lytics user field that contains the conversion ID that will be used for deduplication in Reddit.

config.country_codeoptionalstring

Select the 2 letter country code where the users are located. If not provided, "US" will be used as default.

config.currency_codeoptionalstring

Select the currency code, three letter code in ISO-4217 format. 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.event_timestampoptionalstring

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

config.event_typeoptionalstring

Select the type of the conversion event. If not selected, the event will be sent with **lytics_audiences}** custom name.

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 Reddit API.

config.item_countoptionalstring

Select the Lytics user field that contains the number of item sold.

config.segment_idsrequiredstring[]

Select the Lytics audiences that contains the users to export

config.user_data_mappingoptionalobject[]

Map Lytics user fields to Reddit User Data. Atleast one user data or click id must be provided.

config.valueoptionalstring

Select the Lytics user field that contains monetary 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