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. Databricks System Event Export

Databricks System Event Export

markdownView as Markdown

Create and manage data import and export jobs.

DatabricksSystemEventExport: Create job

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

Create a DatabricksSystemEventExport job

Sample Request
12345678910111213141516171819202122232425
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "catalog": "string",
    "continuous_update": true,
    "database": "string",
    "end_date": "string",
    "start_date": "string",
    "subject_id": "string",
    "subject_type": "string",
    "table_name": "string",
    "time_of_day": "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
{
  "_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": {
      "catalog": "string",
      "continuous_update": true,
      "database": "string",
      "end_date": "string",
      "start_date": "string",
      "subject_id": "string",
      "subject_type": "string",
      "table_name": "string",
      "time_of_day": "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
}

DatabricksSystemEventExport: Get job

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

Get the summary of a DatabricksSystemEventExport job

Sample Response
Status|200 OK
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
{
  "_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": {
      "catalog": "string",
      "continuous_update": true,
      "database": "string",
      "end_date": "string",
      "start_date": "string",
      "subject_id": "string",
      "subject_type": "string",
      "table_name": "string",
      "time_of_day": "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
}

DatabricksSystemEventExport: Update job

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

Update a DatabricksSystemEventExport job

Sample Request
12345678910111213141516171819202122232425
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "catalog": "string",
    "continuous_update": true,
    "database": "string",
    "end_date": "string",
    "start_date": "string",
    "subject_id": "string",
    "subject_type": "string",
    "table_name": "string",
    "time_of_day": "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
{
  "_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": {
      "catalog": "string",
      "continuous_update": true,
      "database": "string",
      "end_date": "string",
      "start_date": "string",
      "subject_id": "string",
      "subject_type": "string",
      "table_name": "string",
      "time_of_day": "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.catalogoptionalstring

Select the Catalog that has the database

config.continuous_updateoptionalboolean

(Optional) Continuously run this export

config.databaserequiredstring

Select the schema (database) to export system events to

config.end_dateoptionalstring

(Optional) Export system events up to this date (ex: 2020-01-01). If no end date is given then system events up to the current date will be exported.

config.start_dateoptionalstring

(Optional) Export system events after this date (ex: 2020-01-01). If no start date is given then system events for last 30 days will be exported.

config.subject_idoptionalstring

(Optional) Provide the Subject ID for above system event subject type you would like to export (work_id, segment_id, account_id). Only events specific to this Subject ID will be exported.

config.subject_typeoptionalstring

(Optional) Provide the Subject Type of system events you would like to export (work, segment, account). Only events specific to this Subject Type will be exported.

config.table_nameoptionalstring

(Optional) Select the Databricks table you want to export system events to. If an existing table is not selected then one will be created. If no table name is entered lytics_system_event_export_{AID} will be used

config.time_of_dayoptionalstring

(Optional) Time of day to start export each day

config.timezoneoptionalstring

(Optional) 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.catalogoptionalstring

Select the Catalog that has the database

config.continuous_updateoptionalboolean

(Optional) Continuously run this export

config.databaserequiredstring

Select the schema (database) to export system events to

config.end_dateoptionalstring

(Optional) Export system events up to this date (ex: 2020-01-01). If no end date is given then system events up to the current date will be exported.

config.start_dateoptionalstring

(Optional) Export system events after this date (ex: 2020-01-01). If no start date is given then system events for last 30 days will be exported.

config.subject_idoptionalstring

(Optional) Provide the Subject ID for above system event subject type you would like to export (work_id, segment_id, account_id). Only events specific to this Subject ID will be exported.

config.subject_typeoptionalstring

(Optional) Provide the Subject Type of system events you would like to export (work, segment, account). Only events specific to this Subject Type will be exported.

config.table_nameoptionalstring

(Optional) Select the Databricks table you want to export system events to. If an existing table is not selected then one will be created. If no table name is entered lytics_system_event_export_{AID} will be used

config.time_of_dayoptionalstring

(Optional) Time of day to start export each day

config.timezoneoptionalstring

(Optional) 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