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

Quantcast Capi Export

markdownView as Markdown

Create and manage data import and export jobs.

QuantcastCapiExport: Create job

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

Create a QuantcastCapiExport job

Sample Request
1234567891011121314151617181920212223242526272829303132333435
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "audience_events": "enters_only",
    "event_name": "string",
    "event_time_field": "string",
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "labels_field": "string",
    "orderid_field": "string",
    "product_category_field": "string",
    "referer_field": "string",
    "revenue_field": "string",
    "segment_id": "string",
    "url_field": "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
{
  "_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": {
      "audience_events": "enters_only",
      "event_name": "string",
      "event_time_field": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "labels_field": "string",
      "orderid_field": "string",
      "product_category_field": "string",
      "referer_field": "string",
      "revenue_field": "string",
      "segment_id": "string",
      "url_field": "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
}

QuantcastCapiExport: Get job

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

Get the summary of a QuantcastCapiExport job

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
{
  "_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": {
      "audience_events": "enters_only",
      "event_name": "string",
      "event_time_field": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "labels_field": "string",
      "orderid_field": "string",
      "product_category_field": "string",
      "referer_field": "string",
      "revenue_field": "string",
      "segment_id": "string",
      "url_field": "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
}

QuantcastCapiExport: Update job

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

Update a QuantcastCapiExport job

Sample Request
1234567891011121314151617181920212223242526272829303132333435
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "audience_events": "enters_only",
    "event_name": "string",
    "event_time_field": "string",
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "labels_field": "string",
    "orderid_field": "string",
    "product_category_field": "string",
    "referer_field": "string",
    "revenue_field": "string",
    "segment_id": "string",
    "url_field": "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
{
  "_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": {
      "audience_events": "enters_only",
      "event_name": "string",
      "event_time_field": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "labels_field": "string",
      "orderid_field": "string",
      "product_category_field": "string",
      "referer_field": "string",
      "revenue_field": "string",
      "segment_id": "string",
      "url_field": "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.audience_eventsoptionalstring

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

One of: enters_only, exits_only

config.event_namerequiredstring

Enter the conversion event name to send (e.g. purchase, signup). Sent as the name field on every conversion.

config.event_time_fieldoptionalstring

Select the Lytics user field with the event time as a Unix epoch timestamp. Defaults to Quantcast's receive time when unmapped.

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.identifier_mappingrequiredobject[]

Map a Lytics user field to a Quantcast identifier (token, external_id, email, client_user_agent, client_ip). Each conversion needs at least one identifier; email is SHA-256 hashed automatically.

config.labels_fieldoptionalstring

Optional. Select the Lytics user field with additional event labels. A multi-value field is sent as the labels array.

config.orderid_fieldoptionalstring

Optional. Select the Lytics user field with the order identifier for commerce conversions.

config.product_category_fieldoptionalstring

Optional. Select the Lytics user field with the product category for commerce conversions.

config.referer_fieldoptionalstring

Optional. Select the Lytics user field with the referring URL for the event.

config.revenue_fieldoptionalstring

Optional. Select the Lytics user field with the conversion revenue. Sent as a number with no currency denomination.

config.segment_idrequiredstring

Select the Lytics audience that contains the users to export

config.url_fieldoptionalstring

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

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

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

One of: enters_only, exits_only

config.event_namerequiredstring

Enter the conversion event name to send (e.g. purchase, signup). Sent as the name field on every conversion.

config.event_time_fieldoptionalstring

Select the Lytics user field with the event time as a Unix epoch timestamp. Defaults to Quantcast's receive time when unmapped.

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.identifier_mappingrequiredobject[]

Map a Lytics user field to a Quantcast identifier (token, external_id, email, client_user_agent, client_ip). Each conversion needs at least one identifier; email is SHA-256 hashed automatically.

config.labels_fieldoptionalstring

Optional. Select the Lytics user field with additional event labels. A multi-value field is sent as the labels array.

config.orderid_fieldoptionalstring

Optional. Select the Lytics user field with the order identifier for commerce conversions.

config.product_category_fieldoptionalstring

Optional. Select the Lytics user field with the product category for commerce conversions.

config.referer_fieldoptionalstring

Optional. Select the Lytics user field with the referring URL for the event.

config.revenue_fieldoptionalstring

Optional. Select the Lytics user field with the conversion revenue. Sent as a number with no currency denomination.

config.segment_idrequiredstring

Select the Lytics audience that contains the users to export

config.url_fieldoptionalstring

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

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