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. Gcs Import Opus

Gcs Import Opus

markdownView as Markdown

Create and manage data import and export jobs.

GcsImportOpus: Create job

POSThttps://api.lytics.io/v2/job/gcs-import-opus

Create a GcsImportOpus job

Sample Request
1234567891011121314151617181920212223242526272829303132
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "bucket": "string",
    "continuous_update": true,
    "day_of_week": "string",
    "delete_file": true,
    "file_type": "string",
    "gzip": true,
    "pgp": true,
    "prefix": "string",
    "project": "string",
    "run_frequency": "string",
    "since": "string",
    "skip_bad_files": true,
    "starting_file": "string",
    "stream": "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
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": {
      "bucket": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "delete_file": true,
      "file_type": "string",
      "gzip": true,
      "pgp": true,
      "prefix": "string",
      "project": "string",
      "run_frequency": "string",
      "since": "string",
      "skip_bad_files": true,
      "starting_file": "string",
      "stream": "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
}

GcsImportOpus: Get job

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

Get the summary of a GcsImportOpus 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": {
      "bucket": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "delete_file": true,
      "file_type": "string",
      "gzip": true,
      "pgp": true,
      "prefix": "string",
      "project": "string",
      "run_frequency": "string",
      "since": "string",
      "skip_bad_files": true,
      "starting_file": "string",
      "stream": "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
}

GcsImportOpus: Update job

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

Update a GcsImportOpus job

Sample Request
1234567891011121314151617181920212223242526272829303132
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "bucket": "string",
    "continuous_update": true,
    "day_of_week": "string",
    "delete_file": true,
    "file_type": "string",
    "gzip": true,
    "pgp": true,
    "prefix": "string",
    "project": "string",
    "run_frequency": "string",
    "since": "string",
    "skip_bad_files": true,
    "starting_file": "string",
    "stream": "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
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": {
      "bucket": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "delete_file": true,
      "file_type": "string",
      "gzip": true,
      "pgp": true,
      "prefix": "string",
      "project": "string",
      "run_frequency": "string",
      "since": "string",
      "skip_bad_files": true,
      "starting_file": "string",
      "stream": "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.bucketoptionalstring

The Google Cloud Storage bucket you want to import data from

config.continuous_updateoptionalboolean

Select to import continuously

config.day_of_weekoptionalstring

Day of week to run work

config.delete_fileoptionalboolean

Select to allow the import job to delete the file after successful import. **Caution**: This will delete the file from the source bucket

config.file_typeoptionalstring

Select the type of file

config.gzipoptionalboolean

Select if the file is gzip compressed

config.pgpoptionalboolean

Select if the file is pgp encrypted

config.prefixoptionalstring

Enter the file name prefix to filter files by. Example new_users_

config.projectoptionalstring

Enter the Google Project ID you want to import data from

config.run_frequencyoptionalstring

Select how often the import should look for new files

config.sinceoptionalstring

Enter the oldest date to import files since. Only files newer then this date will be imported. Use yyyy/mm/dd HH:MM/SS format. If left blank all files created after Starting File will be imported

config.skip_bad_filesoptionalboolean

Select to skip files with formatting errors and continue processing other files. When disabled, any bad file will fail the entire import job

config.starting_fileoptionalstring

Select the file you would like to import first. Only newer files will be imported

config.streamoptionalstring

Enter the data stream to add events to. If left blank, events will be added to the gcs_files data-stream

config.time_of_dayoptionalstring

Time of day to start import each day

config.timestamp_fieldoptionalstring

Enter the field containing the event timestamp

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

The Google Cloud Storage bucket you want to import data from

config.continuous_updateoptionalboolean

Select to import continuously

config.day_of_weekoptionalstring

Day of week to run work

config.delete_fileoptionalboolean

Select to allow the import job to delete the file after successful import. **Caution**: This will delete the file from the source bucket

config.file_typeoptionalstring

Select the type of file

config.gzipoptionalboolean

Select if the file is gzip compressed

config.pgpoptionalboolean

Select if the file is pgp encrypted

config.prefixoptionalstring

Enter the file name prefix to filter files by. Example new_users_

config.projectoptionalstring

Enter the Google Project ID you want to import data from

config.run_frequencyoptionalstring

Select how often the import should look for new files

config.sinceoptionalstring

Enter the oldest date to import files since. Only files newer then this date will be imported. Use yyyy/mm/dd HH:MM/SS format. If left blank all files created after Starting File will be imported

config.skip_bad_filesoptionalboolean

Select to skip files with formatting errors and continue processing other files. When disabled, any bad file will fail the entire import job

config.starting_fileoptionalstring

Select the file you would like to import first. Only newer files will be imported

config.streamoptionalstring

Enter the data stream to add events to. If left blank, events will be added to the gcs_files data-stream

config.time_of_dayoptionalstring

Time of day to start import each day

config.timestamp_fieldoptionalstring

Enter the field containing the event timestamp

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