Improvado Embedded API v3

Loads

Endpointhttps://embedded.improvado.io

Configure and manage data loading from data tables to destinations.

Load orders define the rules and settings for how data moves from Improvado's data tables to your destination systems. This includes:

Source data table selection
Destination connection and target location
Load schedule and frequency
Data transformation and mapping rules
Load mode (full refresh, incremental, etc.)

Loads ensure your data is automatically synchronized from Improvado to your destination on the schedule you define.

List loads

GET

https://embedded.improvado.io

/api/v3/loads

List all loads

List loads › query Parameters

data_table_id

integer

Data Table ID

destination_connection_id

string

Destination Connection ID

destination_name

string

Destination Name

List loads › Responses

200

Get a list of Loads

object[]

count

integer

Number of loads

next

string

URL to the next page

previous

string

URL to the previous page

object[]

List of Loads

GET/api/v3/loads

curl --request GET \
  --url https://embedded.improvado.io/api/v3/loads

shell

Example Responses

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "data_table": {
        "id": 1,
        "title": "Table 1",
        "datasource_name": "google_sheets"
      },
      "destination_connection": {
        "id": 1,
        "title": "Destination Connection 1",
        "destination_name": "google_sheets"
      },
      "destination_table": "table_1",
      "run_policy": "after extraction",
      "schedules": [
        {
          "days": 1,
          "hours": 1,
          "minutes": 1,
          "interval": "daily",
          "timezone": "UTC",
          "lookback_window": {
            "name": "1 day"
          }
        }
      ],
      "status": "active",
      "last_update": "2021-01-01T00:00:00Z",
      "error_text": "Error text",
      "uploaded_rows_count": 1
    },
    {
      "id": 2,
      "data_table": {
        "id": 2,
        "title": "Table 2",
        "datasource_name": "google_ads"
      },
      "destination_connection": {
        "id": 2,
        "title": "Destination Connection 2",
        "destination_name": "google_ads"
      },
      "destination_table": "table_2",
      "run_policy": "after extraction",
      "schedules": [
        {
          "days": 1,
          "hours": 1,
          "minutes": 1,
          "interval": "daily",
          "timezone": "UTC",
          "lookback_window": {
            "name": "1 day"
          }
        }
      ],
      "status": "active",
      "last_update": "2021-01-01T00:00:00Z",
      "error_text": "Error text",
      "uploaded_rows_count": 1
    }
  ]
}

json

application/json

Create a load

POST

https://embedded.improvado.io

/api/v3/loads

Request to this endpoint created a new load. New load creation request is composed of Data Table and Destination connection data.

Create a load › Request Body

data_table_id

integer

Data Table ID

destination_connection_id

integer

Destination Connection ID

destination_table

string

Destination Table

run_policy

string

Run Policy

object[]

load_historical_data

string

Load Historical Date

Create a load › Responses

Create a Load

Load object

id

integer

Load ID

object

Data Table object

Example: {"data_table":{"value":{"id":1,"title":"Table 1","datasource_name":"google_sheets"}}}

object

destination_table

string

Destination table name

run_policy

string

Run policy

object[]

status

string

Load status

last_update

string

Last update date

error_text

string

Error text

uploaded_rows_count

integer

Number of uploaded rows

POST/api/v3/loads

curl --request POST \
  --url https://embedded.improvado.io/api/v3/loads \
  --header 'Content-Type: application/json' \
  --data '
{
  "data_table_id": 1,
  "destination_connection_id": 1,
  "destination_table": "table_1",
  "run_policy": "after extraction",
  "schedules": [
    {
      "days": 1,
      "hours": 1,
      "minutes": 1,
      "interval": "daily",
      "timezone": "UTC",
      "lookback_window": {
        "name": "1 day"
      }
    }
  ],
  "load_historical_data": "2021-01-01T00:00:00Z"
}
'

shell

Example Request Body

{
  "data_table_id": 1,
  "destination_connection_id": 1,
  "destination_table": "table_1",
  "run_policy": "after extraction",
  "schedules": [
    {
      "days": 1,
      "hours": 1,
      "minutes": 1,
      "interval": "daily",
      "timezone": "UTC",
      "lookback_window": {
        "name": "1 day"
      }
    }
  ],
  "load_historical_data": "2021-01-01T00:00:00Z"
}

json

application/json

Example Responses

{
  "id": 1,
  "data_table": {
    "id": 1,
    "title": "Table 1",
    "datasource_name": "google_sheets"
  },
  "destination_connection": {
    "id": 1,
    "title": "Destination Connection 1",
    "destination_name": "google_sheets"
  },
  "destination_table": "table_1",
  "run_policy": "after extraction",
  "schedules": [
    {
      "days": 1,
      "hours": 1,
      "minutes": 1,
      "interval": "daily",
      "timezone": "UTC",
      "lookback_window": {
        "name": "1 day"
      }
    }
  ],
  "status": "active",
  "last_update": "2021-01-01T00:00:00Z",
  "error_text": "Error text",
  "uploaded_rows_count": 1
}

json

application/json

Get a load

GET

https://embedded.improvado.io

/api/v3/loads/{load_id}

Get detailed info about load

Get a load › path Parameters

load_id

integer · required

Load ID

Get a load › Responses

Get a Load

Load object

id

integer

Load ID

object

Data Table object

Example: {"data_table":{"value":{"id":1,"title":"Table 1","datasource_name":"google_sheets"}}}

object

destination_table

string

Destination table name

run_policy

string

Run policy

object[]

status

string

Load status

last_update

string

Last update date

error_text

string

Error text

uploaded_rows_count

integer

Number of uploaded rows

GET/api/v3/loads/{load_id}

curl --request GET \
  --url https://embedded.improvado.io/api/v3/loads/:load_id

shell

Example Responses

{
  "id": 1,
  "data_table": {
    "id": 1,
    "title": "Table 1",
    "datasource_name": "google_sheets"
  },
  "destination_connection": {
    "id": 1,
    "title": "Destination Connection 1",
    "destination_name": "google_sheets"
  },
  "destination_table": "table_1",
  "run_policy": "after extraction",
  "schedules": [
    {
      "days": 1,
      "hours": 1,
      "minutes": 1,
      "interval": "daily",
      "timezone": "UTC",
      "lookback_window": {
        "name": "1 day"
      }
    }
  ],
  "status": "active",
  "last_update": "2021-01-01T00:00:00Z",
  "error_text": "Error text",
  "uploaded_rows_count": 1
}

json

application/json

Update a load

PUT

https://embedded.improvado.io

/api/v3/loads/{load_id}

Allows to update load run policy or scheduling

Update a load › path Parameters

load_id

integer · required

Load ID

Update a load › Request Body

run_policy

string

Run Policy

object[]

Update a load › Responses

Update a Load

Load object

id

integer

Load ID

object

Data Table object

Example: {"data_table":{"value":{"id":1,"title":"Table 1","datasource_name":"google_sheets"}}}

object

destination_table

string

Destination table name

run_policy

string

Run policy

object[]

status

string

Load status

last_update

string

Last update date

error_text

string

Error text

uploaded_rows_count

integer

Number of uploaded rows

PUT/api/v3/loads/{load_id}

curl --request PUT \
  --url https://embedded.improvado.io/api/v3/loads/:load_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "run_policy": "after extraction",
  "schedules": [
    {
      "days": 1,
      "hours": 1,
      "minutes": 1,
      "interval": "daily",
      "timezone": "UTC",
      "lookback_window": {
        "name": "1 day"
      }
    }
  ]
}
'

shell

Example Request Body

{
  "run_policy": "after extraction",
  "schedules": [
    {
      "days": 1,
      "hours": 1,
      "minutes": 1,
      "interval": "daily",
      "timezone": "UTC",
      "lookback_window": {
        "name": "1 day"
      }
    }
  ]
}

json

application/json

Example Responses

{
  "id": 1,
  "data_table": {
    "id": 1,
    "title": "Table 1",
    "datasource_name": "google_sheets"
  },
  "destination_connection": {
    "id": 1,
    "title": "Destination Connection 1",
    "destination_name": "google_sheets"
  },
  "destination_table": "table_1",
  "run_policy": "after extraction",
  "schedules": [
    {
      "days": 1,
      "hours": 1,
      "minutes": 1,
      "interval": "daily",
      "timezone": "UTC",
      "lookback_window": {
        "name": "1 day"
      }
    }
  ],
  "status": "active",
  "last_update": "2021-01-01T00:00:00Z",
  "error_text": "Error text",
  "uploaded_rows_count": 1
}

json

application/json

Delete a load

DELETE

https://embedded.improvado.io

/api/v3/loads/{load_id}

Allows to delete load. Already loaded data will remain in customer’s destination.

Delete a load › path Parameters

load_id

integer · required

Load ID

Delete a load › Responses

Delete a Load

No data returned

Pause a load

PUT

https://embedded.improvado.io

/api/v3/loads/{id}/pause

Allows to pause load so it will not load data to customer’s destination until it is unpaused.

Pause a load › path Parameters

id

integer · required

Load ID

Pause a load › Responses

Pause a Load

No data returned

Unpause a load

PUT

https://embedded.improvado.io

/api/v3/loads/{id}/unpause

Allows to unpaused load so it will continue to load data to customer’s destination.

Unpause a load › path Parameters

id

integer · required

Load ID

Unpause a load › Responses

Unpause a Load

No data returned

Run a load

PUT

https://embedded.improvado.io

/api/v3/loads/{id}/run

Allows to manually run data load into customer’s destination. Optionally provide date_from and date_to in the request body to run the load for a specific date range. Both fields must be provided together. Date range is ignored for loads by accounts.

Run a load › path Parameters

id

integer · required

Load ID

Run a load › Request Body optional

date_from

string · date

Start date for the load run (YYYY-MM-DD). Must be used together with date_to.

Example: 2024-01-01

date_to

string · date

End date for the load run (YYYY-MM-DD). Must be used together with date_from.

Example: 2024-01-31

Run a load › Responses

Run a Load

No data returned

Destination connections iframe

List loads

GET

https://embedded.improvado.io

/api/v3/loads

List all loads

List loads › query Parameters

data_table_id

integer

Data Table ID

destination_connection_id

string

Destination Connection ID

destination_name

string

Destination Name

List loads › Responses

200

Get a list of Loads

object[]

count

integer

Number of loads

next

string

URL to the next page

previous

string

URL to the previous page

object[]

List of Loads

Create a load

POST

https://embedded.improvado.io

/api/v3/loads

Request to this endpoint created a new load. New load creation request is composed of Data Table and Destination connection data.

Create a load › Request Body

data_table_id

integer

Data Table ID

destination_connection_id

integer

Destination Connection ID

destination_table

string

Destination Table

run_policy

string

Run Policy

object[]

load_historical_data

string

Load Historical Date

Create a load › Responses

Create a Load

Load object

id

integer

Load ID

object

Data Table object

Example: {"data_table":{"value":{"id":1,"title":"Table 1","datasource_name":"google_sheets"}}}

object

destination_table

string

Destination table name

run_policy

string

Run policy

object[]

status

string

Load status

last_update

string

Last update date

error_text

string

Error text

uploaded_rows_count

integer

Number of uploaded rows

Get a load

GET

https://embedded.improvado.io

/api/v3/loads/{load_id}

Get detailed info about load

Get a load › path Parameters

load_id

integer · required

Load ID

Get a load › Responses

Get a Load

Load object

id

integer

Load ID

object

Data Table object

Example: {"data_table":{"value":{"id":1,"title":"Table 1","datasource_name":"google_sheets"}}}

object

destination_table

string

Destination table name

run_policy

string

Run policy

object[]

status

string

Load status

last_update

string

Last update date

error_text

string

Error text

uploaded_rows_count

integer

Number of uploaded rows

Update a load

PUT

https://embedded.improvado.io

/api/v3/loads/{load_id}

Allows to update load run policy or scheduling

Update a load › path Parameters

load_id

integer · required

Load ID

Update a load › Request Body

run_policy

string

Run Policy

object[]

Update a load › Responses

Update a Load

Load object

id

integer

Load ID

object

Data Table object

Example: {"data_table":{"value":{"id":1,"title":"Table 1","datasource_name":"google_sheets"}}}

object

destination_table

string

Destination table name

run_policy

string

Run policy

object[]

status

string

Load status

last_update

string

Last update date

error_text

string

Error text

uploaded_rows_count

integer

Number of uploaded rows

Run a load

PUT

https://embedded.improvado.io

/api/v3/loads/{id}/run

Run a load › path Parameters

id

integer · required

Load ID

Run a load › Request Body optional

date_from

string · date

Start date for the load run (YYYY-MM-DD). Must be used together with date_to.

Example: 2024-01-01

date_to

string · date

End date for the load run (YYYY-MM-DD). Must be used together with date_from.

Example: 2024-01-31

Run a load › Responses

Run a Load

No data returned