IMimprovado
Loads

Create a load

Creates a new load. A load creation request is composed of Data Table and Destination Connection data.

Validation rules:

  • When run_policy is "schedule", schedules must contain at least one entry.
  • When run_policy is "after extraction", schedules must be empty or omitted.
post/api/v3/loads

Request

Request body

data_table_idinteger required

Data Table ID

destination_connection_idstring uuid required

Destination Connection ID (UUID)

destination_tablestring required

Destination Table

run_policy'after extraction' | 'schedule' required

When the load runs:

  • after extraction — runs automatically after the related extract finishes.
  • schedule — runs on the recurring schedule(s) defined in schedules.
load_historical_databoolean

When true, the initial load run will backfill historical data for the data table.

Example request

{
  "schedules": [
    {
      "scheduling": {
        "value": {
          "days": 1,
          "hours": 1,
          "minutes": 1,
          "interval": "day",
          "timezone": "UTC",
          "lookback_window": {
            "name": "default"
          }
        }
      }
    }
  ]
}

Response

Create a Load

idinteger

Load ID

destination_tablestring

Destination table name

run_policy'after extraction' | 'schedule'

Load run policy

statusstring

Load status

last_updatestring

Last update date

error_textstring

Error text

uploaded_rows_countinteger

Number of uploaded rows

Example response

{
  "load": {
    "value": {
      "id": 1,
      "data_table": {
        "id": 1,
        "title": "Table 1",
        "datasource_name": "google_sheets"
      },
      "destination_connection": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "title": "Destination Connection 1",
        "destination_name": "google_sheets"
      },
      "destination_table": "table_1",
      "run_policy": "after extraction",
      "schedules": [],
      "status": "active",
      "last_update": "2021-01-01T00:00:00Z",
      "error_text": "",
      "uploaded_rows_count": 1
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.