Improvado Embedded API v3

Accounts

Endpointhttps://embedded.improvado.io

Manage connection accounts from which data is extracted.

Accounts represent specific accounts within a data source platform. Each account is associated with a connection and can have multiple extracts configured to pull data from it.

List accounts for connection

GET

https://embedded.improvado.io

/api/v3/connections/{connection_id}/accounts

List accounts for connection

List accounts for connection › path Parameters

connection_id

integer · required

Connection ID

List accounts for connection › Responses

Get a list of Accounts

object[]

count

integer

Number of accounts

next

string

URL to the next page

previous

string

URL to the previous page

object[]

GET/api/v3/connections/{connection_id}/accounts

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

shell

Example Responses

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "account_id": "12345678-1234-5678-1234-567812345678",
      "title": "Account 1",
      "currency": "USD",
      "connection_id": 1,
      "datasource_name": "google_sheets",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z",
      "is_active": true,
      "enabled_for_embedded_extraction": true,
      "item": {
        "currency": "USD",
        "advertiser_status": "ACTIVE"
      }
    },
    {
      "id": 2,
      "account_id": "12345678-1234-5678-1234-567812345678",
      "title": "Account 2",
      "currency": "USD",
      "connection_id": 2,
      "datasource_name": "google_ads",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z",
      "is_active": true,
      "enabled_for_embedded_extraction": true,
      "item": {
        "currency": "USD",
        "advertiser_status": "ACTIVE"
      }
    }
  ]
}

json

application/json

Update accounts

PATCH

https://embedded.improvado.io

/api/v3/connections/{connection_id}/accounts

Update accounts

Update accounts › path Parameters

connection_id

integer · required

Connection ID

Update accounts › Request Body

object[]

id

integer

Account ID

enabled_for_embedded_extraction

boolean

Enabled for embedded extraction

Update accounts › Responses

Update Accounts

object[]

Account object

id

integer

Account ID

account_id

string

Remote account ID

title

string

Account title

currency

string

Account currency

connection_id

integer

Connection ID

datasource_name

string

Data source name

created_at

string

Account creation date

updated_at

string

Account update date

is_active

boolean

Is the account active

enabled_for_embedded_extraction

boolean

Is the account enabled for embedded extraction

object

Data source-specific account item information

PATCH/api/v3/connections/{connection_id}/accounts

curl --request PATCH \
  --url https://embedded.improvado.io/api/v3/connections/:connection_id/accounts \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "enabled_for_embedded_extraction": true
  },
  {
    "id": 2,
    "enabled_for_embedded_extraction": false
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "enabled_for_embedded_extraction": true
  },
  {
    "id": 2,
    "enabled_for_embedded_extraction": false
  }
]

json

application/json

Example Responses

[
  {
    "id": 1,
    "account_id": "12345678-1234-5678-1234-567812345678",
    "title": "Account 1",
    "currency": "USD",
    "connection_id": 1,
    "datasource_name": "google_sheets",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z",
    "is_active": true,
    "enabled_for_embedded_extraction": true
  },
  {
    "id": 2,
    "account_id": "12345678-1234-5678-1234-567812345678",
    "title": "Account 2",
    "currency": "USD",
    "connection_id": 2,
    "datasource_name": "google_ads",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z",
    "is_active": true,
    "enabled_for_embedded_extraction": false
  }
]

json

application/json

Update an account

PATCH

https://embedded.improvado.io

/api/v3/connections/{connection_id}/accounts/{account_id}

Update an account

Update an account › path Parameters

connection_id

integer · required

Connection ID

account_id

integer · required

Account ID

Update an account › Request Body

enabled_for_embedded_extraction

boolean

Enabled for embedded extraction

Update an account › Responses

Update an Account

Account object

id

integer

Account ID

account_id

string

Remote account ID

title

string

Account title

currency

string

Account currency

connection_id

integer

Connection ID

datasource_name

string

Data source name

created_at

string

Account creation date

updated_at

string

Account update date

is_active

boolean

Is the account active

enabled_for_embedded_extraction

boolean

Is the account enabled for embedded extraction

object

Data source-specific account item information

Data source connections Extraction templates

List accounts for connection

GET

https://embedded.improvado.io

/api/v3/connections/{connection_id}/accounts

List accounts for connection

List accounts for connection › path Parameters

connection_id

integer · required

Connection ID

List accounts for connection › Responses

Get a list of Accounts

object[]

count

integer

Number of accounts

next

string

URL to the next page

previous

string

URL to the previous page

object[]

Update accounts

PATCH

https://embedded.improvado.io

/api/v3/connections/{connection_id}/accounts

Update accounts

Update accounts › path Parameters

connection_id

integer · required

Connection ID

Update accounts › Request Body

object[]

id

integer

Account ID

enabled_for_embedded_extraction

boolean

Enabled for embedded extraction

Update accounts › Responses

Update Accounts

object[]

Account object

id

integer

Account ID

account_id

string

Remote account ID

title

string

Account title

currency

string

Account currency

connection_id

integer

Connection ID

datasource_name

string

Data source name

created_at

string

Account creation date

updated_at

string

Account update date

is_active

boolean

Is the account active

enabled_for_embedded_extraction

boolean

Is the account enabled for embedded extraction

object

Data source-specific account item information

Update an account

PATCH

https://embedded.improvado.io

/api/v3/connections/{connection_id}/accounts/{account_id}

Update an account

Update an account › path Parameters

connection_id

integer · required

Connection ID

account_id

integer · required

Account ID

Update an account › Request Body

enabled_for_embedded_extraction

boolean

Enabled for embedded extraction

Update an account › Responses

Update an Account

Account object

id

integer

Account ID

account_id

string

Remote account ID

title

string

Account title

currency

string

Account currency

connection_id

integer

Connection ID

datasource_name

string

Data source name

created_at

string

Account creation date

updated_at

string

Account update date

is_active

boolean

Is the account active

enabled_for_embedded_extraction

boolean

Is the account enabled for embedded extraction

object

Data source-specific account item information