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

S3 Event Export

markdownView as Markdown

Create and manage data import and export jobs.

S3_EventExport: Create job

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

Create a S3_EventExport job

Sample Request
123456789101112131415161718192021222324252627282930313233
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "bucket": "string",
    "compress": "string",
    "continuous_update": true,
    "day_of_week": "string",
    "directory": "string",
    "email_me": true,
    "end_date": "2019-08-24T14:15:22Z",
    "filename": "string",
    "region": "string",
    "run_frequency": "string",
    "start_date": "2019-08-24T14:15:22Z",
    "streams": [
      "string"
    ],
    "time_format": "string",
    "time_of_day": "string",
    "timezone": "string",
    "write_headers": 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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
{
  "_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",
      "compress": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "directory": "string",
      "email_me": true,
      "end_date": "2019-08-24T14:15:22Z",
      "filename": "string",
      "region": "string",
      "run_frequency": "string",
      "start_date": "2019-08-24T14:15:22Z",
      "streams": [
        "string"
      ],
      "time_format": "string",
      "time_of_day": "string",
      "timezone": "string",
      "write_headers": 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
}

S3_EventExport: Get job

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

Get the summary of a S3_EventExport job

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
{
  "_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",
      "compress": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "directory": "string",
      "email_me": true,
      "end_date": "2019-08-24T14:15:22Z",
      "filename": "string",
      "region": "string",
      "run_frequency": "string",
      "start_date": "2019-08-24T14:15:22Z",
      "streams": [
        "string"
      ],
      "time_format": "string",
      "time_of_day": "string",
      "timezone": "string",
      "write_headers": 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
}

S3_EventExport: Update job

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

Update a S3_EventExport job

Sample Request
123456789101112131415161718192021222324252627282930313233
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "bucket": "string",
    "compress": "string",
    "continuous_update": true,
    "day_of_week": "string",
    "directory": "string",
    "email_me": true,
    "end_date": "2019-08-24T14:15:22Z",
    "filename": "string",
    "region": "string",
    "run_frequency": "string",
    "start_date": "2019-08-24T14:15:22Z",
    "streams": [
      "string"
    ],
    "time_format": "string",
    "time_of_day": "string",
    "timezone": "string",
    "write_headers": 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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
{
  "_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",
      "compress": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "directory": "string",
      "email_me": true,
      "end_date": "2019-08-24T14:15:22Z",
      "filename": "string",
      "region": "string",
      "run_frequency": "string",
      "start_date": "2019-08-24T14:15:22Z",
      "streams": [
        "string"
      ],
      "time_format": "string",
      "time_of_day": "string",
      "timezone": "string",
      "write_headers": 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.bucketoptionalstring

Select or enter the bucket that you would like to save your files in

config.compressoptionalstring

Compress file

config.continuous_updateoptionalboolean

Run this export continuously

config.day_of_weekoptionalstring

Day of week to run work

config.directoryoptionalstring

Select or enter the directory that you would like to save your files in. This can be slow on large S3 buckets

config.email_meoptionalboolean

Whether to send export link

config.end_dateoptionalstring (date-time)

Events before, but NOT including this date will be exported. Use yyyy-mm-dd format (ex: 2015-08-13)

config.filenameoptionalstring

'{TIMESTAMP}' will be replaced with the time interval. May include folder ex: /myfolder/myfile-{TIMESTAMP}. File extension e.g., .csv, .csv.gz will automatically be added

config.regionoptionalstring

AWS region that S3 resides in (us-east-2, etc.)

config.run_frequencyoptionalstring

Choose how often a continuous export should export a new file. Default is daily

config.start_dateoptionalstring (date-time)

Events from this date onwards will be exported. Use yyyy-mm-dd format (ex: 2015-08-13)

config.streamsoptionalstring[]

Choose data to export, a stream is a single source/type of data (you may choose more than one). If none are selected, all streams are exported

config.time_formatoptionalstring

The format for the timestamp at the end of the filename. MM = month, mm = minute

config.time_of_dayoptionalstring
config.timezoneoptionalstring
config.write_headersoptionalboolean

Check to include the field names as the first row of the exported file

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

Select or enter the bucket that you would like to save your files in

config.compressoptionalstring

Compress file

config.continuous_updateoptionalboolean

Run this export continuously

config.day_of_weekoptionalstring

Day of week to run work

config.directoryoptionalstring

Select or enter the directory that you would like to save your files in. This can be slow on large S3 buckets

config.email_meoptionalboolean

Whether to send export link

config.end_dateoptionalstring (date-time)

Events before, but NOT including this date will be exported. Use yyyy-mm-dd format (ex: 2015-08-13)

config.filenameoptionalstring

'{TIMESTAMP}' will be replaced with the time interval. May include folder ex: /myfolder/myfile-{TIMESTAMP}. File extension e.g., .csv, .csv.gz will automatically be added

config.regionoptionalstring

AWS region that S3 resides in (us-east-2, etc.)

config.run_frequencyoptionalstring

Choose how often a continuous export should export a new file. Default is daily

config.start_dateoptionalstring (date-time)

Events from this date onwards will be exported. Use yyyy-mm-dd format (ex: 2015-08-13)

config.streamsoptionalstring[]

Choose data to export, a stream is a single source/type of data (you may choose more than one). If none are selected, all streams are exported

config.time_formatoptionalstring

The format for the timestamp at the end of the filename. MM = month, mm = minute

config.time_of_dayoptionalstring
config.timezoneoptionalstring
config.write_headersoptionalboolean

Check to include the field names as the first row of the exported file

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