Improvado Embedded API v3

Data source connections

Endpointhttps://embedded.improvado.io

Manage connections to data sources for authentication and data access.

Connections handle authentication with data sources and maintain the credentials needed for data extraction. Connections are typically created through the iframe UI, where users can:

Provide username/password credentials
Complete OAuth flows
Configure additional connection parameters

Connection lifecycle:

Create connection via iframe (provides OAuth or credential input)
Validate connection status
Use connection to create extracts
Monitor connection health and refresh tokens as needed

List data source connections

GET

https://embedded.improvado.io

/api/v3/datasources/{datasource_name}/connections

Returns list of connections within workspace by data source

List data source connections › path Parameters

datasource_name

string · required

Data source name

List data source connections › Responses

Get a list of Connections

object[]

connection list

count

integer

Number of connections

next

string

URL to the next page

previous

string

URL to the previous page

object[]

GET/api/v3/datasources/{datasource_name}/connections

curl --request GET \
  --url https://embedded.improvado.io/api/v3/datasources/:datasource_name/connections

shell

Example Responses

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "uid": "12345678-1234-5678-1234-567812345678",
      "title": "Connection 1",
      "datasource_name": "google_sheets",
      "status": "active",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z",
      "accounts_number": 1,
      "accounts_status": "active",
      "update_accounts_last_successed": "2021-01-01T00:00:00Z",
      "update_accounts_was_successfull": true
    },
    {
      "id": 2,
      "uid": "12345678-1234-5678-1234-567812345678",
      "title": "Connection 2",
      "datasource_name": "google_ads",
      "status": "active",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z",
      "accounts_number": 1,
      "accounts_status": "active",
      "update_accounts_last_successed": "2021-01-01T00:00:00Z",
      "update_accounts_was_successfull": true
    }
  ]
}

json

application/json

Delete a connection

DELETE

https://embedded.improvado.io

/api/v3/datasources/{datasource_name}/connections/{id}

Delete specified connection. Also related accounts are marked as inactive (is_active property becomes false) and related extractions are paused.

Delete a connection › path Parameters

datasource_name

string · required

Datasource name

id

integer · required

Connection ID

Delete a connection › Responses

Delete a Connection

No data returned

Delete a connection

DELETE

https://embedded.improvado.io

/api/v3/connections/{connection_id}

Delete specified connection. Also related accounts are marked as inactive (is_active property becomes false) and related extractions are paused.

Delete a connection › path Parameters

connection_id

integer · required

Connection ID

Delete a connection › Responses

Delete a Connection

No data returned

Data sources Accounts

List data source connections

GET

https://embedded.improvado.io

/api/v3/datasources/{datasource_name}/connections

Returns list of connections within workspace by data source

List data source connections › path Parameters

datasource_name

string · required

Data source name

List data source connections › Responses

Get a list of Connections

object[]

connection list

count

integer

Number of connections

next

string

URL to the next page

previous

string

URL to the previous page

object[]

Delete a connection

DELETE

https://embedded.improvado.io

/api/v3/datasources/{datasource_name}/connections/{id}

Delete specified connection. Also related accounts are marked as inactive (is_active property becomes false) and related extractions are paused.

Delete a connection › path Parameters

datasource_name

string · required

Datasource name

id

integer · required

Connection ID

Delete a connection › Responses

Delete a Connection

No data returned

Delete a connection

DELETE

https://embedded.improvado.io

/api/v3/connections/{connection_id}

Delete specified connection. Also related accounts are marked as inactive (is_active property becomes false) and related extractions are paused.

Delete a connection › path Parameters

connection_id

integer · required

Connection ID

Delete a connection › Responses

Delete a Connection

No data returned