--- title: "S3_EventExport: Create job" method: POST path: "/job/s3-event-export" tags: ["Jobs"] --- # S3_EventExport: Create job `POST /job/s3-event-export` ## Request - Base URL: `https://api.lytics.io/v2` - URL: `https://api.lytics.io/v2/job/s3-event-export` - Auth: API key in header `Authorization` Create a S3_EventExport job ## Query parameters - `account_id` string ## Request body `*/*` - object - `auth_ids` string[]: Authorization IDs associated with the Job - `config` object, required: Job configuration, unique per-workflow - `bucket` string: Select or enter the bucket that you would like to save your files in - `compress` string: Compress file - `continuous_update` boolean: Run this export continuously - `day_of_week` string: Day of week to run work - `directory` string: Select or enter the directory that you would like to save your files in. This can be slow on large S3 buckets - `email_me` boolean: Whether to send export link - `end_date` string, date-time: Events before, but NOT including this date will be exported. Use yyyy-mm-dd format (ex: 2015-08-13) - `filename` string: '{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 - `region` string: AWS region that S3 resides in (us-east-2, etc.) - `run_frequency` string: Choose how often a continuous export should export a new file. Default is daily - `start_date` string, date-time: Events from this date onwards will be exported. Use yyyy-mm-dd format (ex: 2015-08-13) - `streams` string[]: 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 - `time_format` string: The format for the timestamp at the end of the filename. MM = month, mm = minute - `time_of_day` string - `timezone` string - `write_headers` boolean: Check to include the field names as the first row of the exported file - `description` string: A user-defined description - `drop_events_during_quiet_window` boolean - `expires_at` string, date-time - `monitoring` object: Inline monitoring config. On write: omit to keep, null to clear, or a config to set. - `name` string, required: A user-defined name - `quiet_period` integer - `quiet_time_of_day` string - `quiet_timezone` string ## Response `201` S3_EventExport Job - object - `_meta` object: Response Metadata - `data` object: Response Payload - `account_id` string: Lytics Account ID - `anomaly_rule` ModelsAnomalyRuleResp - `aid` integer - `checks` ModelsRuleCheckConfigReq[] - `allowable_violations` integer - `interval` string - `lookback_count` integer - `max_threshold` integer - `metric_type` string - `min_threshold` integer - `type` string - `variance_pct` number - `created` string - `id` string - `subject_id` string - `subject_type` string - `updated` string - `api_token_auth_id` string: this is set when work is create using access token - `auth_ids` string[]: Authorization IDs associated with the Job - `config` object, required: Job configuration, unique per-workflow - `bucket` string: Select or enter the bucket that you would like to save your files in - `compress` string: Compress file - `continuous_update` boolean: Run this export continuously - `day_of_week` string: Day of week to run work - `directory` string: Select or enter the directory that you would like to save your files in. This can be slow on large S3 buckets - `email_me` boolean: Whether to send export link - `end_date` string, date-time: Events before, but NOT including this date will be exported. Use yyyy-mm-dd format (ex: 2015-08-13) - `filename` string: '{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 - `region` string: AWS region that S3 resides in (us-east-2, etc.) - `run_frequency` string: Choose how often a continuous export should export a new file. Default is daily - `start_date` string, date-time: Events from this date onwards will be exported. Use yyyy-mm-dd format (ex: 2015-08-13) - `streams` string[]: 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 - `time_format` string: The format for the timestamp at the end of the filename. MM = month, mm = minute - `time_of_day` string - `timezone` string - `write_headers` boolean: Check to include the field names as the first row of the exported file - `created` string - `deleted` boolean: The Job has been deleted - `description` string: A user-defined description - `drop_events_during_quiet_window` boolean - `expires_at` string, date-time - `id` string: A Lytics-assigned, immutable unique ID for the Job - `meta` object: Extra meta data about the job - `monitoring` object: Inline monitoring config. On write: omit to keep, null to clear, or a config to set. - `name` string, required: A user-defined name - `quiet_period` integer - `quiet_time_of_day` string - `quiet_timezone` string - `sleep_until` string - `status` 'runnable' | 'sleeping' | 'paused' | 'completed' | 'fault' | 'failed' | 'killed' | 'deleted' | 'unknown': The status of the job - `updated` string - `user_id` string: The user ID that created or updated the job - `workflow` string: The workflow slug - `workflow_id` string: The workflow ID - `request_id` string - `status` integer: HTTP Status Code ## Other responses - `404`: Not Found - `500`: Internal Server Error ## Changes - **2026-11-03** `d8e975057aec`: 1 info - endpoint added [Operation history](https://skmtc.dev/lytics/apis/lytics-api/changes/job/s3-event-export/post.md) --- [API](https://skmtc.dev/lytics/apis/lytics-api.md) - [All operations](https://skmtc.dev/lytics/apis/lytics-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lytics/apis/lytics-api/revisions/d8e975057aec?raw)