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. Bigquery Event Export

Bigquery Event Export

markdownView as Markdown

Create and manage data import and export jobs.

BigqueryEventExport: Create job

POSThttps://api.lytics.io/v2/job/bigquery-event-export

Create a BigqueryEventExport job

Sample Request
1234567891011121314151617181920212223242526272829303132
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "continuous": true,
    "dataset": "string",
    "end_date": "string",
    "event_limit": 0,
    "export_cadence": "string",
    "flatten_streams": true,
    "partition_duration": "string",
    "partitioned": true,
    "project": "string",
    "single_table": true,
    "start_date": "string",
    "stream_fields": [
      "string"
    ],
    "streams": [
      "string"
    ]
  },
  "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
{
  "_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": {
      "continuous": true,
      "dataset": "string",
      "end_date": "string",
      "event_limit": 0,
      "export_cadence": "string",
      "flatten_streams": true,
      "partition_duration": "string",
      "partitioned": true,
      "project": "string",
      "single_table": true,
      "start_date": "string",
      "stream_fields": [
        "string"
      ],
      "streams": [
        "string"
      ]
    },
    "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
}

BigqueryEventExport: Get job

GEThttps://api.lytics.io/v2/job/bigquery-event-export/{id}

Get the summary of a BigqueryEventExport job

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
{
  "_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": {
      "continuous": true,
      "dataset": "string",
      "end_date": "string",
      "event_limit": 0,
      "export_cadence": "string",
      "flatten_streams": true,
      "partition_duration": "string",
      "partitioned": true,
      "project": "string",
      "single_table": true,
      "start_date": "string",
      "stream_fields": [
        "string"
      ],
      "streams": [
        "string"
      ]
    },
    "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
}

BigqueryEventExport: Update job

PUThttps://api.lytics.io/v2/job/bigquery-event-export/{id}

Update a BigqueryEventExport job

Sample Request
1234567891011121314151617181920212223242526272829303132
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "continuous": true,
    "dataset": "string",
    "end_date": "string",
    "event_limit": 0,
    "export_cadence": "string",
    "flatten_streams": true,
    "partition_duration": "string",
    "partitioned": true,
    "project": "string",
    "single_table": true,
    "start_date": "string",
    "stream_fields": [
      "string"
    ],
    "streams": [
      "string"
    ]
  },
  "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
{
  "_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": {
      "continuous": true,
      "dataset": "string",
      "end_date": "string",
      "event_limit": 0,
      "export_cadence": "string",
      "flatten_streams": true,
      "partition_duration": "string",
      "partitioned": true,
      "project": "string",
      "single_table": true,
      "start_date": "string",
      "stream_fields": [
        "string"
      ],
      "streams": [
        "string"
      ]
    },
    "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.continuousoptionalboolean

Continuously run this export.

config.datasetrequiredstring

The Google BigQuery Dataset you want to export data to

config.end_dateoptionalstring
config.event_limitoptionalinteger
config.export_cadenceoptionalstring
config.flatten_streamsoptionalboolean

Selecting this option will export all streams to one BigQuery table

config.partition_durationoptionalstring

Select the duration of the table's partitions. This is ignored if Partitioned Table is not selected

config.partitionedoptionalboolean

Using partitioned tables can help lower query costs by allowing you to target a specific date range of data instead of the whole data set. Tables will be partitioned by event date

config.projectrequiredstring

The Google BigQuery Project you want to export data to

config.single_tableoptionalboolean

Select this option to export all configured streams to a single table called events_lytics_all. If deselected, each stream will be exported to a separate table with the naming convention `events_{stream_name}

config.start_dateoptionalstring
config.stream_fieldsoptionalstring[]

Choose data stream fields to export. If none are selected, all fields for selected stream will be exported

config.streamsoptionalstring[]
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.continuousoptionalboolean

Continuously run this export.

config.datasetrequiredstring

The Google BigQuery Dataset you want to export data to

config.end_dateoptionalstring
config.event_limitoptionalinteger
config.export_cadenceoptionalstring
config.flatten_streamsoptionalboolean

Selecting this option will export all streams to one BigQuery table

config.partition_durationoptionalstring

Select the duration of the table's partitions. This is ignored if Partitioned Table is not selected

config.partitionedoptionalboolean

Using partitioned tables can help lower query costs by allowing you to target a specific date range of data instead of the whole data set. Tables will be partitioned by event date

config.projectrequiredstring

The Google BigQuery Project you want to export data to

config.single_tableoptionalboolean

Select this option to export all configured streams to a single table called events_lytics_all. If deselected, each stream will be exported to a separate table with the naming convention `events_{stream_name}

config.start_dateoptionalstring
config.stream_fieldsoptionalstring[]

Choose data stream fields to export. If none are selected, all fields for selected stream will be exported

config.streamsoptionalstring[]
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