WEweld
ELT Syncs

Get ELT Sync

Changed on

Get data of a specific ELT sync.

get/elt_syncs/{id}

Request

  • Base URL
    https://connect.weld.app
  • URL
    https://connect.weld.app/elt_syncs/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required
Example:X4ughggABSd3UY

The ID of the ELT sync.

Response

account_idstring required

The Id of the Account.

configobject

The configuration for the ELT sync.

elt_settingsobject

The ELT settings of the sync, in the shape elt_settings takes when creating or updating an ELT sync. Holds only the settings the source's settings schema declares, custom report definitions included; config holds everything the sync stores. Returned when getting a single ELT sync, and absent when the source cannot resolve its settings schema.

created_atstring date-time required

The datetime when the ELT Sync was created.

destination_connection_idstring required

The Id of the Destination Connection.

destination_integration_idstring required

The Id of the Destination Integration.

destination_schema_namestring

The name of the destination schema.

enabledboolean required

Whether the ELT sync is enabled and running on its schedule.

identifier_casing'UPPERCASE' nullable

Casing applied to the identifiers created in the destination. Snowflake destinations only. Null when the sync applies no casing.

idstring required

The Id of the ELT Sync.

orchestration_workflow_idstring

The Id of the Orchestration Workflow that the sync is attached to.

source_connection_idstring required

The Id of the Source Connection.

source_integration_idstring required

The Id of the Source Integration.

start_datestring date-time

The date from when the sync should synchronize the data.

status'NOT_STARTED' | 'RUNNING' | 'FAILED' | 'PAUSED' required

The status of the sync.

sync_intervalstring cron expression

The cron expression when the sync should run. Provided if sync is not attached to an Orchestration.

updated_atstring date-time required

The datetime when the ELT Sync was last updated.

Example response

{
  "account_id": "acc_789",
  "config": {
    "sourceSettings": {}
  },
  "elt_settings": {
    "start_date": "2024-01-01"
  },
  "created_at": "2020-01-01T00:00:00.000Z",
  "destination_connection_id": "conn_456",
  "destination_integration_id": "bigquery",
  "destination_schema_name": "my_schema",
  "enabled": true,
  "identifier_casing": "UPPERCASE",
  "id": "OoORhGXUVjsqFG",
  "orchestration_workflow_id": "3LIw2FdxoByya9",
  "source_connection_id": "conn_123",
  "source_integration_id": "excel",
  "source_streams": [
    {
      "id": "SCTVdLAcyDTgNx",
      "elt_sync_id": "3LIw2FdxoByya9",
      "name": "users",
      "incremental_primary_key_name": [
        "id"
      ],
      "primary_keys": [
        "id"
      ],
      "excluded_columns": [
        "email"
      ],
      "hashed_columns": [
        "phone"
      ],
      "incremental_pointer_id": "updated_at",
      "additional_incremental_pointer_ids": [
        "closed_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 * * *",
      "full_sync_schedule": "0 3 * * 0"
    }
  ],
  "start_date": "2020-01-01T00:00:00.000Z",
  "status": "RUNNING",
  "sync_interval": "0 0 * * *",
  "updated_at": "2020-01-01T00:00:00.000Z"
}

Changes

  • 4f3762e39f50Revision changes
    • info

      added the required property // to the response with the status

  • 85974449323dRevision changes
    • breaking

      the response property became nullable for the status

    • info

      added the optional property to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status