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

Openai Capi Export

markdownView as Markdown

Create and manage data import and export jobs.

OpenaiCapiExport: Create job

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

Create a OpenaiCapiExport job

Sample Request
12345678910111213141516171819202122232425262728293031323334353637383940414243
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "action_source": "web",
    "audience_events": "enters_only",
    "currency": "string",
    "custom_event_name": "string",
    "event_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "event_type": "string",
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "opt_out": true,
    "pixel_id": "string",
    "segment_ids": [
      "string"
    ],
    "source_url": "string",
    "value_units": "major",
    "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
{
  "_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",
      "currency": "string",
      "custom_event_name": "string",
      "event_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "event_type": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "opt_out": true,
      "pixel_id": "string",
      "segment_ids": [
        "string"
      ],
      "source_url": "string",
      "value_units": "major",
      "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
}

OpenaiCapiExport: Get job

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

Get the summary of a OpenaiCapiExport job

Sample Response
Status|200 OK
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
{
  "_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",
      "currency": "string",
      "custom_event_name": "string",
      "event_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "event_type": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "opt_out": true,
      "pixel_id": "string",
      "segment_ids": [
        "string"
      ],
      "source_url": "string",
      "value_units": "major",
      "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
}

OpenaiCapiExport: Update job

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

Update a OpenaiCapiExport job

Sample Request
12345678910111213141516171819202122232425262728293031323334353637383940414243
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "action_source": "web",
    "audience_events": "enters_only",
    "currency": "string",
    "custom_event_name": "string",
    "event_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "event_type": "string",
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "opt_out": true,
    "pixel_id": "string",
    "segment_ids": [
      "string"
    ],
    "source_url": "string",
    "value_units": "major",
    "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
{
  "_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",
      "currency": "string",
      "custom_event_name": "string",
      "event_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "event_type": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "opt_out": true,
      "pixel_id": "string",
      "segment_ids": [
        "string"
      ],
      "source_url": "string",
      "value_units": "major",
      "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 happened

One of: web, mobile_app, offline, physical_store, phone_call, email, other

config.audience_eventsoptionalstring

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

One of: enters_only, exits_only

config.currencyoptionalstring

Three letter ISO 4217 currency code used when the conversion value is not mapped to its own currency field

config.custom_event_nameoptionalstring

Enter the event name to use when the event type is custom

config.event_mappingoptionalobject[]

Map Lytics fields to OpenAI event fields

config.event_typerequiredstring

Select the OpenAI conversion event type

config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events

config.identifier_mappingrequiredobject[]

Map Lytics fields to OpenAI user matching fields

config.opt_outoptionalboolean

Opt these events out of future user level personalization

config.pixel_idrequiredstring

Enter the OpenAI Pixel ID that these conversions belong to

config.segment_idsrequiredstring[]

Select the Lytics audiences that contain the users to export

config.source_urloptionalstring

Enter a fallback source URL for web events whose mapped URL field is empty

config.value_unitsoptionalstring

Whether the mapped conversion value is in major units (dollars) or minor units (cents)

One of: major, minor

config.withbackfilloptionalboolean

Send users who already exist in the selected Lytics audience on first run

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 happened

One of: web, mobile_app, offline, physical_store, phone_call, email, other

config.audience_eventsoptionalstring

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

One of: enters_only, exits_only

config.currencyoptionalstring

Three letter ISO 4217 currency code used when the conversion value is not mapped to its own currency field

config.custom_event_nameoptionalstring

Enter the event name to use when the event type is custom

config.event_mappingoptionalobject[]

Map Lytics fields to OpenAI event fields

config.event_typerequiredstring

Select the OpenAI conversion event type

config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events

config.identifier_mappingrequiredobject[]

Map Lytics fields to OpenAI user matching fields

config.opt_outoptionalboolean

Opt these events out of future user level personalization

config.pixel_idrequiredstring

Enter the OpenAI Pixel ID that these conversions belong to

config.segment_idsrequiredstring[]

Select the Lytics audiences that contain the users to export

config.source_urloptionalstring

Enter a fallback source URL for web events whose mapped URL field is empty

config.value_unitsoptionalstring

Whether the mapped conversion value is in major units (dollars) or minor units (cents)

One of: major, minor

config.withbackfilloptionalboolean

Send users who already exist in the selected Lytics audience on first run

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