IMimprovado
Automated Recipes

Get a recipe template

Returns one recipe template with the templates it is built on and the columns of the table a recipe from it produces. Use it to check a template before you deploy it: output_columns is available without deploying anything, and an empty output_columns means the schema could not be read, not that the table has no columns.

template_id is an integer. A value that is not a positive integer answers 404 not_found, the same as a template that does not exist, belongs to another agency or cannot be deployed through the API.

get/api/v3.1/automated-recipe-templates/{template_id}/

Request

Path parameters

template_idinteger required

Recipe template identifier, as returned by the template list.

Response

The recipe template

idinteger

Template identifier. Pass it as template_id when you create a recipe.

titlestring

Template name. It can be changed in the interface, and the name in force when a recipe is created decides the name of that recipe's output table.

descriptionstring

Template description, as entered in the interface. Can be empty.

origin'improvado' | 'agency'

Who the template comes from. improvado - a template we provide; agency - a template your agency created by promoting one of its own recipes. Agency templates are the ones the interface shows as custom. New values can be added, so tolerate unknown ones.

build_mode'progressive' | 'atomic'

How a recipe from this template builds when one data source delivers no data. progressive - that data source is left out, the rest is built and the recipe becomes ready_to_work with degraded: true; if every data source fails, the recipe fails. atomic - a single failing data source fails the whole recipe. In both modes individual accounts that did not deliver never fail the recipe on their own. New values can be added, so tolerate unknown ones.

levelinteger

Depth of this template in its own tree; 0 for a template you can deploy.

dependencies_countinteger

How many templates this one depends on, counted over the whole tree.

created_atstring date-time

When the template was created.

updated_atstring date-time

When the template was last changed.

Changes

No recorded changes to this operation across all 1 revision of this API.