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 Import

Bigquery Import

markdownView as Markdown

Create and manage data import and export jobs.

BigqueryImport: Create job

POSThttps://api.lytics.io/v2/job/bigquery-import

Create a BigqueryImport job

Sample Request
12345678910111213141516171819202122232425262728
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "continuous_update": true,
    "dataset": "string",
    "day_of_week": "string",
    "encode_bytes": "string",
    "project": "string",
    "record_timestamp": "string",
    "row_limit": 0,
    "run_frequency": "string",
    "stream": "string",
    "table": "string",
    "time_of_day": "string",
    "timestamp_field": "string",
    "timezone": "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
{
  "_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_update": true,
      "dataset": "string",
      "day_of_week": "string",
      "encode_bytes": "string",
      "project": "string",
      "record_timestamp": "string",
      "row_limit": 0,
      "run_frequency": "string",
      "stream": "string",
      "table": "string",
      "time_of_day": "string",
      "timestamp_field": "string",
      "timezone": "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
}

BigqueryImport: Get job

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

Get the summary of a BigqueryImport job

Sample Response
Status|200 OK
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
{
  "_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_update": true,
      "dataset": "string",
      "day_of_week": "string",
      "encode_bytes": "string",
      "project": "string",
      "record_timestamp": "string",
      "row_limit": 0,
      "run_frequency": "string",
      "stream": "string",
      "table": "string",
      "time_of_day": "string",
      "timestamp_field": "string",
      "timezone": "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
}

BigqueryImport: Update job

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

Update a BigqueryImport job

Sample Request
12345678910111213141516171819202122232425262728
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "continuous_update": true,
    "dataset": "string",
    "day_of_week": "string",
    "encode_bytes": "string",
    "project": "string",
    "record_timestamp": "string",
    "row_limit": 0,
    "run_frequency": "string",
    "stream": "string",
    "table": "string",
    "time_of_day": "string",
    "timestamp_field": "string",
    "timezone": "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
{
  "_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_update": true,
      "dataset": "string",
      "day_of_week": "string",
      "encode_bytes": "string",
      "project": "string",
      "record_timestamp": "string",
      "row_limit": 0,
      "run_frequency": "string",
      "stream": "string",
      "table": "string",
      "time_of_day": "string",
      "timestamp_field": "string",
      "timezone": "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.continuous_updateoptionalboolean

Continuously run this import. If this option is selected, the Timestamp Field must be provided

config.datasetrequiredstring
config.day_of_weekoptionalstring

Day of week to run work

config.encode_bytesoptionalstring

Select how to ecnode BYTES fields

config.projectrequiredstring
config.record_timestampoptionalstring

Enter a timestamp field to use as the event timestamp in Lytics. If none is entered, Timestamp Field will be used

config.row_limitoptionalinteger

Limit the number of rows to import for testing purposes

config.run_frequencyoptionalstring

Select the frequency at which to run the import

config.streamoptionalstring

The stream where imported data will go

config.tablerequiredstring

The Google BigQuery table you would like to import

config.time_of_dayoptionalstring

Time of day to start import each day

config.timestamp_fieldoptionalstring

Select the name of the field that contains the event timestamp. On continuous imports, the most recent time in this field will be saved. On the next import, only rows with a timestamp greater than that value will be imported

config.timezoneoptionalstring

Timezone for time of day

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

Continuously run this import. If this option is selected, the Timestamp Field must be provided

config.datasetrequiredstring
config.day_of_weekoptionalstring

Day of week to run work

config.encode_bytesoptionalstring

Select how to ecnode BYTES fields

config.projectrequiredstring
config.record_timestampoptionalstring

Enter a timestamp field to use as the event timestamp in Lytics. If none is entered, Timestamp Field will be used

config.row_limitoptionalinteger

Limit the number of rows to import for testing purposes

config.run_frequencyoptionalstring

Select the frequency at which to run the import

config.streamoptionalstring

The stream where imported data will go

config.tablerequiredstring

The Google BigQuery table you would like to import

config.time_of_dayoptionalstring

Time of day to start import each day

config.timestamp_fieldoptionalstring

Select the name of the field that contains the event timestamp. On continuous imports, the most recent time in this field will be saved. On the next import, only rows with a timestamp greater than that value will be imported

config.timezoneoptionalstring

Timezone for time of day

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