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

Snapchat Capi Export

markdownView as Markdown

Create and manage data import and export jobs.

SnapchatCapiExport: Create job

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

Create a SnapchatCapiExport job

Sample Request
1234567891011121314151617181920212223242526272829303132333435363738
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "action_source": "WEB",
    "audience_events": "enters_only",
    "conversion_id": "string",
    "currency_code": "string",
    "event_name": "string",
    "event_source_url_field": "string",
    "event_timestamp": "string",
    "field_changes": [
      "string"
    ],
    "item_count": "string",
    "pixel_id": "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
{
  "_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": "WEB",
      "audience_events": "enters_only",
      "conversion_id": "string",
      "currency_code": "string",
      "event_name": "string",
      "event_source_url_field": "string",
      "event_timestamp": "string",
      "field_changes": [
        "string"
      ],
      "item_count": "string",
      "pixel_id": "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
}

SnapchatCapiExport: Get job

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

Get the summary of a SnapchatCapiExport job

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
{
  "_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": "WEB",
      "audience_events": "enters_only",
      "conversion_id": "string",
      "currency_code": "string",
      "event_name": "string",
      "event_source_url_field": "string",
      "event_timestamp": "string",
      "field_changes": [
        "string"
      ],
      "item_count": "string",
      "pixel_id": "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
}

SnapchatCapiExport: Update job

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

Update a SnapchatCapiExport job

Sample Request
1234567891011121314151617181920212223242526272829303132333435363738
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "action_source": "WEB",
    "audience_events": "enters_only",
    "conversion_id": "string",
    "currency_code": "string",
    "event_name": "string",
    "event_source_url_field": "string",
    "event_timestamp": "string",
    "field_changes": [
      "string"
    ],
    "item_count": "string",
    "pixel_id": "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
{
  "_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": "WEB",
      "audience_events": "enters_only",
      "conversion_id": "string",
      "currency_code": "string",
      "event_name": "string",
      "event_source_url_field": "string",
      "event_timestamp": "string",
      "field_changes": [
        "string"
      ],
      "item_count": "string",
      "pixel_id": "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 the action source describing where the conversion occurred. Required by Snapchat; defaults to OFFLINE.

One of: WEB, OFFLINE, MOBILE_APP

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.conversion_idoptionalstring

Optional. Select the Lytics user field containing a unique conversion/event ID used for deduplication.

config.currency_codeoptionalstring

Optional. Select the Lytics user field containing the ISO currency code for the conversion value.

config.event_namerequiredstring

Select the Snapchat event to send. Map a custom conversion in Snapchat Ads Manager to a CUSTOM_EVENT_N slot to send your own event.

config.event_source_url_fieldoptionalstring

Optional. Select the Lytics user field containing the URL where the event occurred.

config.event_timestampoptionalstring

Select the Lytics user field containing the event time. Defaults to the processing time when not set. Events more than 7 days old are dropped.

config.field_changesoptionalstring[]

Select up to 75 user fields. If any selected field changes for a user in the exported audience, a conversion event will be sent.

config.item_countoptionalstring

Optional. Select the Lytics user field containing the number of items in the conversion.

config.pixel_idrequiredstring

Enter your Snap Pixel ID (WEB/OFFLINE events) or Snap App ID (MOBILE_APP events) from Snapchat Ads Manager.

config.segment_idsrequiredstring[]

Select the Lytics audiences that contain the users to export

config.user_data_mappingrequiredobject[]

Map Lytics user fields to Snapchat user_data identifiers. At least one identifier is required.

config.valueoptionalstring

Optional. Select the Lytics user field containing the monetary value of the conversion.

config.withbackfilloptionalboolean

Select to immediately push users who currently exist in the selected Lytics audience. Deselecting will only send conversions as users enter or exit 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 the action source describing where the conversion occurred. Required by Snapchat; defaults to OFFLINE.

One of: WEB, OFFLINE, MOBILE_APP

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.conversion_idoptionalstring

Optional. Select the Lytics user field containing a unique conversion/event ID used for deduplication.

config.currency_codeoptionalstring

Optional. Select the Lytics user field containing the ISO currency code for the conversion value.

config.event_namerequiredstring

Select the Snapchat event to send. Map a custom conversion in Snapchat Ads Manager to a CUSTOM_EVENT_N slot to send your own event.

config.event_source_url_fieldoptionalstring

Optional. Select the Lytics user field containing the URL where the event occurred.

config.event_timestampoptionalstring

Select the Lytics user field containing the event time. Defaults to the processing time when not set. Events more than 7 days old are dropped.

config.field_changesoptionalstring[]

Select up to 75 user fields. If any selected field changes for a user in the exported audience, a conversion event will be sent.

config.item_countoptionalstring

Optional. Select the Lytics user field containing the number of items in the conversion.

config.pixel_idrequiredstring

Enter your Snap Pixel ID (WEB/OFFLINE events) or Snap App ID (MOBILE_APP events) from Snapchat Ads Manager.

config.segment_idsrequiredstring[]

Select the Lytics audiences that contain the users to export

config.user_data_mappingrequiredobject[]

Map Lytics user fields to Snapchat user_data identifiers. At least one identifier is required.

config.valueoptionalstring

Optional. Select the Lytics user field containing the monetary value of the conversion.

config.withbackfilloptionalboolean

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