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. Redshift Import

Redshift Import

markdownView as Markdown

Create and manage data import and export jobs.

RedshiftImport: Create job

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

Create a RedshiftImport job

Sample Request
1234567891011121314151617181920212223242526272829
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "connection_url": "string",
    "continuous_update": true,
    "day_of_week": "string",
    "query_timeout": 0,
    "record_timestamp": "string",
    "row_limit": 0,
    "run_frequency": "string",
    "since_date": "2019-08-24T14:15:22Z",
    "source": "string",
    "ssl_mode": "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
{
  "_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": {
      "connection_url": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "query_timeout": 0,
      "record_timestamp": "string",
      "row_limit": 0,
      "run_frequency": "string",
      "since_date": "2019-08-24T14:15:22Z",
      "source": "string",
      "ssl_mode": "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
}

RedshiftImport: Get job

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

Get the summary of a RedshiftImport job

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
{
  "_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": {
      "connection_url": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "query_timeout": 0,
      "record_timestamp": "string",
      "row_limit": 0,
      "run_frequency": "string",
      "since_date": "2019-08-24T14:15:22Z",
      "source": "string",
      "ssl_mode": "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
}

RedshiftImport: Update job

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

Update a RedshiftImport job

Sample Request
1234567891011121314151617181920212223242526272829
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "connection_url": "string",
    "continuous_update": true,
    "day_of_week": "string",
    "query_timeout": 0,
    "record_timestamp": "string",
    "row_limit": 0,
    "run_frequency": "string",
    "since_date": "2019-08-24T14:15:22Z",
    "source": "string",
    "ssl_mode": "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
{
  "_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": {
      "connection_url": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "query_timeout": 0,
      "record_timestamp": "string",
      "row_limit": 0,
      "run_frequency": "string",
      "since_date": "2019-08-24T14:15:22Z",
      "source": "string",
      "ssl_mode": "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.connection_urloptionalstring

The Redshift URL to connect to, leave blank to use the authorization's setting. This will be of the form: redshift-cluster-name.VCP-cluster.region.redshift.amazonaws.com:5439/db-name

config.continuous_updateoptionalboolean

Select to repeatedly run this import on a schedule

config.day_of_weekoptionalstring

Day of week to run work

config.query_timeoutoptionalinteger

Enter the maximum time a query is allowed to run in minutes

config.record_timestampoptionalstring

Select the timestamp column to use as event timestamps, if left blank the Timestamp Column will be used

config.row_limitoptionalinteger

Limit the number of rows to import for testing purposes

config.run_frequencyoptionalstring

Choose how often a repeated import should run

config.since_dateoptionalstring (date-time)

Enter the earliest timestamp to import records from; only records with a Timestamp Column after this date will be imported. Use yyyy-mm-dd HH:MM:SS UTC format

config.sourceoptionalstring

Select the table to import data from

config.ssl_modeoptionalstring

Select the SSL mode to use to connect to the database, leave blank to use the authorization's setting

config.streamoptionalstring

Enter the data stream name you want to add data to. if the data stream does not exist, it will be created. if left blank the data will go to the redshift_TABLE data stream,where TABLE is the name of the Redshift table

config.time_of_dayoptionalstring

Time of day to start import

config.timestamp_fieldoptionalstring

Select the timestamp column to order the events. This column is also used to determine updated rows when running continuously

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

The Redshift URL to connect to, leave blank to use the authorization's setting. This will be of the form: redshift-cluster-name.VCP-cluster.region.redshift.amazonaws.com:5439/db-name

config.continuous_updateoptionalboolean

Select to repeatedly run this import on a schedule

config.day_of_weekoptionalstring

Day of week to run work

config.query_timeoutoptionalinteger

Enter the maximum time a query is allowed to run in minutes

config.record_timestampoptionalstring

Select the timestamp column to use as event timestamps, if left blank the Timestamp Column will be used

config.row_limitoptionalinteger

Limit the number of rows to import for testing purposes

config.run_frequencyoptionalstring

Choose how often a repeated import should run

config.since_dateoptionalstring (date-time)

Enter the earliest timestamp to import records from; only records with a Timestamp Column after this date will be imported. Use yyyy-mm-dd HH:MM:SS UTC format

config.sourceoptionalstring

Select the table to import data from

config.ssl_modeoptionalstring

Select the SSL mode to use to connect to the database, leave blank to use the authorization's setting

config.streamoptionalstring

Enter the data stream name you want to add data to. if the data stream does not exist, it will be created. if left blank the data will go to the redshift_TABLE data stream,where TABLE is the name of the Redshift table

config.time_of_dayoptionalstring

Time of day to start import

config.timestamp_fieldoptionalstring

Select the timestamp column to order the events. This column is also used to determine updated rows when running continuously

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