Get a load

Get detailed info about load

get/api/v3/loads/{load_id}

Request

Base URL
https://embedded.improvado.io
Auth
- HTTP bearer
- or API key in cookie dts_session_id
TypeScript
https://skmtc.dev/improvado/apis/improvado-embedded-api-v3/docs/api/v3/loads/:load_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

load_idinteger required

Load ID

Response

Get 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.