Improvado Embedded API v3

Recipes

Endpointhttps://embedded.improvado.io

Work with pre-built recipes that automate common data pipeline workflows.

Recipes are templated workflows that combine multiple API operations into reusable patterns. They simplify common tasks like:

Setting up end-to-end data pipelines (source → extract → load → destination)
Configuring multiple related extracts at once
Applying best-practice configurations

Recipes accelerate implementation by providing proven patterns for common use cases.

Automated Recipes extend this concept with pre-configured data transformation templates.

Enable recipe in a workspace

POST

https://embedded.improvado.io

/api/v3/workspaces/{id}/recipes

Enables a specific recipe for a given workspace

Enable recipe in a workspace › path Parameters

id

integer · required

Workspace ID

Enable recipe in a workspace › Request Body

recipe_id

integer

Recipe ID

Enable recipe in a workspace › Responses

Recipe is enabled

No data returned

List agency recipes

GET

https://embedded.improvado.io

/api/v3/recipes

Get list of recipes available for agency

List agency recipes › Responses

Get list of recipes available for agency

object[]

Recipe object

id

integer

Recipe ID

title

string

Recipe title

List automated recipe templates

GET

https://embedded.improvado.io

/api/v3/automated-recipe-templates

Returns a paginated list of available automated recipe templates that can be used to create automated recipes.

List automated recipe templates › query Parameters

page

integer

Page number for pagination

Default: 1

page_size

integer · max: 100

Number of results per page (max 100)

Default: 20

search

string

Search templates by name

data_sources

string

Filter by data sources (comma-separated list, e.g., "google_analytics,facebook_ads")

List automated recipe templates › Responses

List of automated recipe templates

Paginated list of automated recipe templates

count

integer

Total number of templates

next

string | null

URL to the next page

previous

string | null

URL to the previous page

object[]

GET/api/v3/automated-recipe-templates

curl --request GET \
  --url https://embedded.improvado.io/api/v3/automated-recipe-templates

shell

Example Responses

{
  "count": 15,
  "next": "/api/v3/automated-recipe-templates/?page=2",
  "previous": null,
  "results": [
    {
      "id": 123,
      "title": "Marketing Attribution Model",
      "description": "Multi-touch attribution analysis combining GA4, Facebook Ads, and Google Ads data",
      "data_sources": [
        {
          "name": "google_analytics",
          "title": "Google Analytics"
        },
        {
          "name": "facebook_ads",
          "title": "Facebook Ads"
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-02-20T14:45:00Z"
    },
    {
      "id": 124,
      "title": "E-commerce Sales Dashboard",
      "description": "Comprehensive sales analytics with product performance metrics",
      "data_sources": [
        {
          "name": "shopify",
          "title": "Shopify"
        }
      ],
      "created_at": "2024-01-20T09:15:00Z",
      "updated_at": "2024-02-18T11:20:00Z"
    }
  ]
}

json

application/json

Get automated recipe template detail

GET

https://embedded.improvado.io

/api/v3/automated-recipe-templates/{template_id}

Returns detailed information about a specific automated recipe template, including its tree structure and dependencies.

Get automated recipe template detail › path Parameters

template_id

integer · required

Automated recipe template ID

Get automated recipe template detail › Responses

Automated recipe template details

Detailed automated recipe template with tree structure

id

integer

Template ID

title

string

Template title

description

string

Template description

object[]

List of data sources used by this template

object

Tree structure showing template dependencies

dependencies_count

integer

Number of dependencies in the template

created_at

string · date-time

Template creation timestamp

updated_at

string · date-time

Template last update timestamp

GET/api/v3/automated-recipe-templates/{template_id}

curl --request GET \
  --url https://embedded.improvado.io/api/v3/automated-recipe-templates/:template_id

shell

Example Responses

{
  "id": 123,
  "title": "Marketing Attribution Model",
  "description": "Multi-touch attribution analysis combining GA4, Facebook Ads, and Google Ads data",
  "data_sources": [
    {
      "name": "google_analytics",
      "title": "Google Analytics"
    },
    {
      "name": "facebook_ads",
      "title": "Facebook Ads"
    }
  ],
  "tree_structure": {
    "root": {
      "id": 123,
      "title": "Marketing Attribution Model",
      "level": 0
    },
    "children": [
      {
        "id": 124,
        "title": "GA4 Base Data",
        "level": 1,
        "parent_id": 123
      },
      {
        "id": 125,
        "title": "Facebook Ads Base Data",
        "level": 1,
        "parent_id": 123
      }
    ]
  },
  "dependencies_count": 2,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-02-20T14:45:00Z"
}

json

application/json

List automated recipes

GET

https://embedded.improvado.io

/api/v3/automated-recipes

Returns a paginated list of automated recipes in the workspace.

List automated recipes › query Parameters

template_id

integer

Filter by template ID

state

string · enum

Filter by recipe state

Enum values:

Extracting Data

Building Dependencies

Ready To Work

Failed

page

integer

Page number for pagination

Default: 1

page_size

integer · max: 100

Number of results per page (max 100)

Default: 20

List automated recipes › Responses

List of automated recipes

Paginated list of automated recipes

count

integer

Total number of recipes

next

string | null

URL to the next page

previous

string | null

URL to the previous page

object[]

GET/api/v3/automated-recipes

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

shell

Example Responses

{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "recipe_id": "12647075758935484548",
      "template_id": 285,
      "template_title": "Cross-Channel Dashboard",
      "title": "Cross-Channel Automated test",
      "state": "Ready To Work",
      "workspace_id": 456,
      "created_at": "2025-11-17T16:09:18.754810Z",
      "updated_at": "2025-11-17T16:11:39.756697Z"
    },
    {
      "recipe_id": "12647075758935484549",
      "template_id": 285,
      "template_title": "Cross-Channel Dashboard",
      "title": "Cross-Channel Q2 2025",
      "state": "Extracting Data",
      "workspace_id": 456,
      "created_at": "2025-04-01T09:15:00Z",
      "updated_at": "2025-04-02T11:20:00Z"
    }
  ]
}

json

application/json

Create automated recipe

POST

https://embedded.improvado.io

/api/v3/automated-recipes

Creates a new automated recipe from a template.

Create automated recipe › Request Body

template_id

integer · required

ID of the automated recipe template

title

string

Recipe name. If not specified, template name is used

Create automated recipe › Responses

Automated recipe created successfully

Response after creating an automated recipe

recipe_id

string

Unique recipe identifier (numeric string)

template_id

integer

ID of the template this recipe was created from

title

string

Recipe title

state

string · enum

Initial recipe state (typically "Extracting Data")

Enum values:

Extracting Data

Building Dependencies

Ready To Work

Failed

Get automated recipe detail

GET

https://embedded.improvado.io

/api/v3/automated-recipes/{recipe_id}

Returns detailed information about a specific automated recipe, including its configuration and connections.

Get automated recipe detail › path Parameters

recipe_id

string · required

Automated recipe ID (numeric string)

Get automated recipe detail › Responses

Automated recipe details

Detailed automated recipe with full configuration

recipe_id

string

Unique recipe identifier (numeric string)

template_id

integer

ID of the template this recipe was created from

datatable_id

integer | null

Associated data table ID (null if not yet created)

title

string

Recipe title

state

string · enum

Current recipe state

Enum values:

Extracting Data

Building Dependencies

Ready To Work

Failed

data_sources

string[]

List of configured data source names

allowed_data_sources

string[]

List of allowed data source names for this recipe

object[]

List of configured connections

sync_from_date

string · date

Start date for data synchronization

last_build_at

string · date-time

Last successful build timestamp

created_at

string · date-time

Recipe creation timestamp

updated_at

string · date-time

Recipe last update timestamp

GET/api/v3/automated-recipes/{recipe_id}

curl --request GET \
  --url https://embedded.improvado.io/api/v3/automated-recipes/:recipe_id

shell

Example Responses

{
  "recipe_id": "12647075758935484548",
  "template_id": 285,
  "datatable_id": 456,
  "title": "Cross-Channel Automated test",
  "state": "Ready To Work",
  "data_sources": [
    "facebook",
    "google_ads_ql"
  ],
  "allowed_data_sources": [
    "facebook",
    "facebook_pages",
    "google_ads_ql",
    "google_dbm",
    "twitter",
    "bing",
    "linkedin_ads",
    "tiktok_ads"
  ],
  "connections": [
    {
      "connection_id": 1039,
      "connection_data_source": "google_ads_ql",
      "accounts": [
        {
          "id": 301010,
          "account_id": "2279787570"
        }
      ]
    },
    {
      "connection_id": 2838,
      "connection_data_source": "facebook",
      "accounts": [
        {
          "id": 67133,
          "account_id": "act_500105056677763"
        }
      ]
    }
  ],
  "sync_from_date": "2025-10-18",
  "last_build_at": "2025-11-17T16:12:33.721081Z",
  "created_at": "2025-11-17T16:09:18.754810Z",
  "updated_at": "2025-11-17T16:11:39.756697Z"
}

json

application/json

Update automated recipe configuration

PUT

https://embedded.improvado.io

/api/v3/automated-recipes/{recipe_id}

Updates the configuration of an automated recipe, including data sources, connections, and sync settings.

Update automated recipe configuration › path Parameters

recipe_id

string · required

Automated recipe ID (numeric string)

Update automated recipe configuration › Request Body

Request body for updating automated recipe configuration

data_sources

string[] · required

List of data source names to include

object[] · required

List of connections with accounts

sync_from_date

string · date

Start date for data synchronization (YYYY-MM-DD)

Update automated recipe configuration › Responses

Recipe configuration updated successfully (empty body)

No data returned

PUT/api/v3/automated-recipes/{recipe_id}

curl --request PUT \
  --url https://embedded.improvado.io/api/v3/automated-recipes/:recipe_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "data_sources": [
    "google_analytics",
    "facebook_ads"
  ],
  "connections": [
    {
      "connection_id": 789,
      "connection_data_source": "google_analytics",
      "accounts": [
        {
          "id": 1,
          "account_id": "UA-12345678-1"
        }
      ]
    }
  ],
  "sync_from_date": "2024-01-01"
}
'

shell

Example Request Body

{
  "data_sources": [
    "google_analytics",
    "facebook_ads"
  ],
  "connections": [
    {
      "connection_id": 789,
      "connection_data_source": "google_analytics",
      "accounts": [
        {
          "id": 1,
          "account_id": "UA-12345678-1"
        }
      ]
    }
  ],
  "sync_from_date": "2024-01-01"
}

json

application/json

Example Responses

No example specified for this content type

Build automated recipe

POST

https://embedded.improvado.io

/api/v3/automated-recipes/{recipe_id}/build

Triggers the build process for an automated recipe. The recipe will transition through states (Extracting Data -> Building Dependencies -> Ready To Work or Failed).

Build automated recipe › path Parameters

recipe_id

string · required

Automated recipe ID (numeric string)

Build automated recipe › Responses

Build started successfully

Response from build operation

status

string · enum

Build operation status

Enum values:

building

error

message

string

Human-readable status message

Workspaces

Improvado Embedded API v3

Recipes

Endpointhttps://embedded.improvado.io

Work with pre-built recipes that automate common data pipeline workflows.

Recipes are templated workflows that combine multiple API operations into reusable patterns. They simplify common tasks like:

Setting up end-to-end data pipelines (source → extract → load → destination)
Configuring multiple related extracts at once
Applying best-practice configurations

Recipes accelerate implementation by providing proven patterns for common use cases.

Automated Recipes extend this concept with pre-configured data transformation templates.

Enable recipe in a workspace

POST

https://embedded.improvado.io

/api/v3/workspaces/{id}/recipes

Enables a specific recipe for a given workspace

Enable recipe in a workspace › path Parameters

id

integer · required

Workspace ID

Enable recipe in a workspace › Request Body

recipe_id

integer

Recipe ID

Enable recipe in a workspace › Responses

Recipe is enabled

No data returned

List agency recipes

GET

https://embedded.improvado.io

/api/v3/recipes

Get list of recipes available for agency

List agency recipes › Responses

Get list of recipes available for agency

object[]

Recipe object

id

integer

Recipe ID

title

string

Recipe title

List automated recipe templates

GET

https://embedded.improvado.io

/api/v3/automated-recipe-templates

Returns a paginated list of available automated recipe templates that can be used to create automated recipes.

List automated recipe templates › query Parameters

page

integer

Page number for pagination

Default: 1

page_size

integer · max: 100

Number of results per page (max 100)

Default: 20

search

string

Search templates by name

data_sources

string

Filter by data sources (comma-separated list, e.g., "google_analytics,facebook_ads")

List automated recipe templates › Responses

List of automated recipe templates

Paginated list of automated recipe templates

count

integer

Total number of templates

next

string | null

URL to the next page

previous

string | null

URL to the previous page

object[]

GET/api/v3/automated-recipe-templates

curl --request GET \
  --url https://embedded.improvado.io/api/v3/automated-recipe-templates

shell

Example Responses

{
  "count": 15,
  "next": "/api/v3/automated-recipe-templates/?page=2",
  "previous": null,
  "results": [
    {
      "id": 123,
      "title": "Marketing Attribution Model",
      "description": "Multi-touch attribution analysis combining GA4, Facebook Ads, and Google Ads data",
      "data_sources": [
        {
          "name": "google_analytics",
          "title": "Google Analytics"
        },
        {
          "name": "facebook_ads",
          "title": "Facebook Ads"
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-02-20T14:45:00Z"
    },
    {
      "id": 124,
      "title": "E-commerce Sales Dashboard",
      "description": "Comprehensive sales analytics with product performance metrics",
      "data_sources": [
        {
          "name": "shopify",
          "title": "Shopify"
        }
      ],
      "created_at": "2024-01-20T09:15:00Z",
      "updated_at": "2024-02-18T11:20:00Z"
    }
  ]
}

json

application/json

Get automated recipe template detail

GET

https://embedded.improvado.io

/api/v3/automated-recipe-templates/{template_id}

Returns detailed information about a specific automated recipe template, including its tree structure and dependencies.

Get automated recipe template detail › path Parameters

template_id

integer · required

Automated recipe template ID

Get automated recipe template detail › Responses

Automated recipe template details

Detailed automated recipe template with tree structure

id

integer

Template ID

title

string

Template title

description

string

Template description

object[]

List of data sources used by this template

object

Tree structure showing template dependencies

dependencies_count

integer

Number of dependencies in the template

created_at

string · date-time

Template creation timestamp

updated_at

string · date-time

Template last update timestamp

GET/api/v3/automated-recipe-templates/{template_id}

curl --request GET \
  --url https://embedded.improvado.io/api/v3/automated-recipe-templates/:template_id

shell

Example Responses

{
  "id": 123,
  "title": "Marketing Attribution Model",
  "description": "Multi-touch attribution analysis combining GA4, Facebook Ads, and Google Ads data",
  "data_sources": [
    {
      "name": "google_analytics",
      "title": "Google Analytics"
    },
    {
      "name": "facebook_ads",
      "title": "Facebook Ads"
    }
  ],
  "tree_structure": {
    "root": {
      "id": 123,
      "title": "Marketing Attribution Model",
      "level": 0
    },
    "children": [
      {
        "id": 124,
        "title": "GA4 Base Data",
        "level": 1,
        "parent_id": 123
      },
      {
        "id": 125,
        "title": "Facebook Ads Base Data",
        "level": 1,
        "parent_id": 123
      }
    ]
  },
  "dependencies_count": 2,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-02-20T14:45:00Z"
}

json

application/json

List automated recipes

GET

https://embedded.improvado.io

/api/v3/automated-recipes

Returns a paginated list of automated recipes in the workspace.

List automated recipes › query Parameters

template_id

integer

Filter by template ID

state

string · enum

Filter by recipe state

Enum values:

Extracting Data

Building Dependencies

Ready To Work

Failed

page

integer

Page number for pagination

Default: 1

page_size

integer · max: 100

Number of results per page (max 100)

Default: 20

List automated recipes › Responses

List of automated recipes

Paginated list of automated recipes

count

integer

Total number of recipes

next

string | null

URL to the next page

previous

string | null

URL to the previous page

object[]

GET/api/v3/automated-recipes

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

shell

Example Responses

{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "recipe_id": "12647075758935484548",
      "template_id": 285,
      "template_title": "Cross-Channel Dashboard",
      "title": "Cross-Channel Automated test",
      "state": "Ready To Work",
      "workspace_id": 456,
      "created_at": "2025-11-17T16:09:18.754810Z",
      "updated_at": "2025-11-17T16:11:39.756697Z"
    },
    {
      "recipe_id": "12647075758935484549",
      "template_id": 285,
      "template_title": "Cross-Channel Dashboard",
      "title": "Cross-Channel Q2 2025",
      "state": "Extracting Data",
      "workspace_id": 456,
      "created_at": "2025-04-01T09:15:00Z",
      "updated_at": "2025-04-02T11:20:00Z"
    }
  ]
}

json

application/json

Create automated recipe

POST

https://embedded.improvado.io

/api/v3/automated-recipes

Creates a new automated recipe from a template.

Create automated recipe › Request Body

template_id

integer · required

ID of the automated recipe template

title

string

Recipe name. If not specified, template name is used

Create automated recipe › Responses

Automated recipe created successfully

Response after creating an automated recipe

recipe_id

string

Unique recipe identifier (numeric string)

template_id

integer

ID of the template this recipe was created from

title

string

Recipe title

state

string · enum

Initial recipe state (typically "Extracting Data")

Enum values:

Extracting Data

Building Dependencies

Ready To Work

Failed

Get automated recipe detail

GET

https://embedded.improvado.io

/api/v3/automated-recipes/{recipe_id}

Returns detailed information about a specific automated recipe, including its configuration and connections.

Get automated recipe detail › path Parameters

recipe_id

string · required

Automated recipe ID (numeric string)

Get automated recipe detail › Responses

Automated recipe details

Detailed automated recipe with full configuration

recipe_id

string

Unique recipe identifier (numeric string)

template_id

integer

ID of the template this recipe was created from

datatable_id

integer | null

Associated data table ID (null if not yet created)

title

string

Recipe title

state

string · enum

Current recipe state

Enum values:

Extracting Data

Building Dependencies

Ready To Work

Failed

data_sources

string[]

List of configured data source names

allowed_data_sources

string[]

List of allowed data source names for this recipe

object[]

List of configured connections

sync_from_date

string · date

Start date for data synchronization

last_build_at

string · date-time

Last successful build timestamp

created_at

string · date-time

Recipe creation timestamp

updated_at

string · date-time

Recipe last update timestamp

GET/api/v3/automated-recipes/{recipe_id}

curl --request GET \
  --url https://embedded.improvado.io/api/v3/automated-recipes/:recipe_id

shell

Example Responses

{
  "recipe_id": "12647075758935484548",
  "template_id": 285,
  "datatable_id": 456,
  "title": "Cross-Channel Automated test",
  "state": "Ready To Work",
  "data_sources": [
    "facebook",
    "google_ads_ql"
  ],
  "allowed_data_sources": [
    "facebook",
    "facebook_pages",
    "google_ads_ql",
    "google_dbm",
    "twitter",
    "bing",
    "linkedin_ads",
    "tiktok_ads"
  ],
  "connections": [
    {
      "connection_id": 1039,
      "connection_data_source": "google_ads_ql",
      "accounts": [
        {
          "id": 301010,
          "account_id": "2279787570"
        }
      ]
    },
    {
      "connection_id": 2838,
      "connection_data_source": "facebook",
      "accounts": [
        {
          "id": 67133,
          "account_id": "act_500105056677763"
        }
      ]
    }
  ],
  "sync_from_date": "2025-10-18",
  "last_build_at": "2025-11-17T16:12:33.721081Z",
  "created_at": "2025-11-17T16:09:18.754810Z",
  "updated_at": "2025-11-17T16:11:39.756697Z"
}

json

application/json

Update automated recipe configuration

PUT

https://embedded.improvado.io

/api/v3/automated-recipes/{recipe_id}

Updates the configuration of an automated recipe, including data sources, connections, and sync settings.

Update automated recipe configuration › path Parameters

recipe_id

string · required

Automated recipe ID (numeric string)

Update automated recipe configuration › Request Body

Request body for updating automated recipe configuration

data_sources

string[] · required

List of data source names to include

object[] · required

List of connections with accounts

sync_from_date

string · date

Start date for data synchronization (YYYY-MM-DD)

Update automated recipe configuration › Responses

Recipe configuration updated successfully (empty body)

No data returned

PUT/api/v3/automated-recipes/{recipe_id}

curl --request PUT \
  --url https://embedded.improvado.io/api/v3/automated-recipes/:recipe_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "data_sources": [
    "google_analytics",
    "facebook_ads"
  ],
  "connections": [
    {
      "connection_id": 789,
      "connection_data_source": "google_analytics",
      "accounts": [
        {
          "id": 1,
          "account_id": "UA-12345678-1"
        }
      ]
    }
  ],
  "sync_from_date": "2024-01-01"
}
'

shell

Example Request Body

{
  "data_sources": [
    "google_analytics",
    "facebook_ads"
  ],
  "connections": [
    {
      "connection_id": 789,
      "connection_data_source": "google_analytics",
      "accounts": [
        {
          "id": 1,
          "account_id": "UA-12345678-1"
        }
      ]
    }
  ],
  "sync_from_date": "2024-01-01"
}

json

application/json

Example Responses

No example specified for this content type

Build automated recipe

POST

https://embedded.improvado.io

/api/v3/automated-recipes/{recipe_id}/build

Triggers the build process for an automated recipe. The recipe will transition through states (Extracting Data -> Building Dependencies -> Ready To Work or Failed).

Build automated recipe › path Parameters

recipe_id

string · required

Automated recipe ID (numeric string)

Build automated recipe › Responses

Build started successfully

Response from build operation

status

string · enum

Build operation status

Enum values:

building

error

message

string

Human-readable status message

Workspaces