IMimprovado
Recipes

DEPRECATED Get automated recipe detail

Deprecated: use GET /api/v3.1/automated-recipes/{recipe_id}/. This version stays available until it is switched off; see Moving recipes to v3.1.

When the recipes service fails, this version answers 500 with an HTML page, and an error in the 4xx range can arrive with a body that is not JSON. It also repeats the request to the recipes service up to three times, create included, so a create can run twice. v3.1 does neither: every error is {code, message, details}, and a request is repeated only when it provably never reached the service.

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

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

Request

Path parameters

recipe_idstring required

Automated recipe ID (numeric string)

Response

Automated recipe details

recipe_idstring

Unique recipe identifier (numeric string)

template_idinteger

ID of the template this recipe was created from

datatable_idinteger nullable

Associated data table ID (null if not yet created)

titlestring

Recipe title

state'Extracting Data' | 'Building Dependencies' | 'Ready to work' | 'Failed'

Current recipe state. Ready to work means the last build was built on the extractions that delivered; extractions that could not deliver on their own or in time were left out, so rows of some accounts can be missing. See Build automated recipe.

data_sourcesstring[]

List of configured data source names

allowed_data_sourcesstring[]

List of allowed data source names for this recipe

sync_from_datestring date nullable

Start date for data synchronization

last_build_atstring date-time nullable

Last time the recipe's setup row changed. Despite the name it is not a build stamp: it moves when the configuration is written and on most build state transitions, but not when POST /build/ is accepted and not when a build failure is recorded. Do not use it to decide whether, or when, a build ran.

created_atstring date-time

Recipe creation timestamp

updated_atstring date-time

Recipe last update timestamp

Changes

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