Sign in
latestOpenAPI 3.0.02026-08-137192110.1 KB

75294f591cc2

ELT Streams

Set ELT Stream Sync Interval

Sets a custom cron schedule for this stream, pulling it out of its ELT Sync's orchestration (or shared schedule) so it runs independently.

post/elt_streams/{id}/set_sync_interval

Path parameters

idstring required
Example:vBjnEbMi9i3P4K

The ID of the ELT Stream to set the sync interval for.

Request body

sync_intervalstring required

Cron expression for the stream to run on its own schedule (e.g. "0 0 * * *").

Example request

{
  "sync_interval": "0 0 * * *"
}

Response

idstring required

The Id of the ELT Stream.

elt_sync_idstring required

The Id of the ELT Sync that the ELT Stream belongs to.

namestring required

The name of the ELT Stream

incremental_primary_key_namestring[]

The name of the primary key field used for incremental sync. Most commonly used for database incremental syncs.

incremental_pointer_idstring

The name of the field used for incremental sync cursor.

full_sync_at_midnightboolean required

Indicates whether the full sync should be performed at midnight.

full_sync_alwaysboolean required

Indicates whether the full sync should always be performed.

protected_from_full_syncboolean required

Indicates whether the stream is protected from full sync.

created_atstring date-time required

The datetime when the ELT Stream was created.

updated_atstring date-time required

The datetime when the ELT Stream was last updated.

excluded_substreamsstring[] required

Excluded substreams from syncing.

enabled_history_tableboolean required

Whether history table(s) are enabled for this stream

sync_intervalstring nullable

Custom cron schedule for this stream. When set, the stream is pulled out of its ELT Sync (orchestration or schedule) and runs on its own schedule. Null means it follows the parent ELT Sync.

Example response

{
  "id": "SCTVdLAcyDTgNx",
  "elt_sync_id": "3LIw2FdxoByya9",
  "name": "users",
  "incremental_primary_key_name": [
    "id"
  ],
  "incremental_pointer_id": "updated_at",
  "created_at": "2020-01-01T00:00:00.000Z",
  "updated_at": "2020-01-01T00:00:00.000Z",
  "excluded_substreams": [
    "substream1",
    "substream2"
  ],
  "sync_interval": "0 0 * * *"
}