PaginatedWorkspaceList
countNumber of workspaces
nextURL to the next page
previousURL to the previous page
Dashboard
dashboard_idDashboard ID
titleDashboard title
data_nameDashboard Data Type
DataSource
namestring identifier of datasource
titleData source title
categoriesList of categories that the data source belongs to
PaginatedDataSourceList
countNumber of datasources
nextURL to the next page
previousURL to the previous page
Connection
idConnection ID
uidConnection UID
titleConnection title
datasource_nameData source name
statusConnection status
created_atConnection creation date
updated_atConnection update date
accounts_numberNumber of accounts
accounts_statusAccounts status
update_accounts_last_successedLast successful accounts update date
update_accounts_was_successfullWas the last accounts update successful
PaginatedConnectionsList
countNumber of connections
nextURL to the next page
previousURL to the previous page
Account
idAccount ID
account_idRemote account ID
titleAccount title
currencyAccount currency
connection_idConnection ID
datasource_nameData source name
created_atAccount creation date
updated_atAccount update date
is_activeIs the account active
enabled_for_embedded_extractionIs the account enabled for embedded extraction
Data source-specific account item information
PaginatedAccountList
countNumber of accounts
nextURL to the next page
previousURL to the previous page
ExtractTemplateCreateRequest
parent_idID of the parent (global) extraction template to base this template on
titleTitle for the new template (must be unique within the agency)
descriptionDescription of the template (can be empty)
fieldsList of field names to include in the template
Extraction schedule configuration
additional_paramsAdditional parameters for the template (e.g. time_granularity)
hashed_fieldsList of field names to hash (optional)
historical_data_depth_limitLimit on historical data depth in days (optional, null for no limit)
connection_idConnection ID, required for wide report templates (parent has allow_to_select_dimensions or is_created_from_wide)
ExtractTemplate
idExtract Template ID
titleExtract Template title
descriptionExtract Template description
data_classData class
datasource_nameData source name
schedules_limitSchedules limit
PaginatedExtractTemplateList
countNumber of extract templates
nextURL to the next page
previousURL to the previous page
Scheduling
daysNumber of days
hoursNumber of hours
minutesNumber of minutes
intervalInterval
timezoneTimezone
Field
titleField title
nameField name
user_kindField kind
user_typeField type
selectedIs the field selected
can_editCan the field be edited
sql_nameSql Name of a Field
formatField format
is_dynamicIs the field dynamic
AdditionalParams
typeAdditional Params type
nameAdditional Params name
requiredIs the Additional Params required
titleAdditional Params title
descriptionAdditional Params description
paramsAdditional Params params
initial_valueAdditional Params initial value
Extract
idExtract ID
titleExtract title
connection_idConnection ID
account_idAccount ID
account_nameAccount name
created_atExtract creation date
last_syncLast sync date
statusExtract status
error_textError text
schedules_limitSchedules limit
sync_historical_dataStart date for historical data backfill (ISO date format, e.g. "2025-02-25"). Null if not set.
PaginatedExtractList
countNumber of extracts
nextURL to the next page
previousURL to the previous page
Destination
namestring identifier of destination
titleDestination title
infoDestination info
PaginatedDestinationList
countNumber of destinations
nextURL to the next page
previousURL to the previous page
DestinationConnection
idDestination Connection ID
Destination object
titleDestination Connection title
updated_atDestination Connection update date
statusDestination Connection status
error_textDestination Connection error text
is_editableIs the Destination Connection editable
create_load_for_new_tablesCreate load for new tables
PaginatedDestinationConnectionList
countNumber of destination connections
nextURL to the next page
previousURL to the previous page
DataTable
idData Table ID
titleData Table title
datasource_nameData source name
TableField
kindField kind
titleField title
sql_nameSQL name
field_typeField type
formatField format
is_dynamicIs the field dynamic
is_selectedIs the field selected
DataTableDetail
titleData Table title
freshnessData Table freshness date
datasource_nameData source name
report_typeReport type
data_classData class
workspaceWorkspace ID
sql_nameSQL name
auto_extract_new_accountsAuto extract new accounts
Fields object
PaginatedDataTableList
countNumber of data tables
nextURL to the next page
previousURL to the previous page
Load
idLoad ID
Data Table object
destination_tableDestination table name
run_policyRun policy
statusLoad status
last_updateLast update date
error_textError text
uploaded_rows_countNumber of uploaded rows
PaginatedLoadList
countNumber of loads
nextURL to the next page
previousURL to the previous page
List of Loads
ExtractTemplatePreviewRequest
connection_idConnection ID to use for the preview.
Custom settings for the extraction.
fieldsList of fields to include in the preview.
dynamic_fieldsList of dynamic fields to include.
accountsList of account IDs.
custom_filtersCustom filters to apply. Null if no filters.
AutomatedRecipeTemplateDataSource
nameData source identifier
titleData source display name
AutomatedRecipeTemplate
idTemplate ID
titleTemplate title
descriptionTemplate description
List of data sources used by this template
created_atTemplate creation timestamp
updated_atTemplate last update timestamp
PaginatedAutomatedRecipeTemplateList
countTotal number of templates
nextURL to the next page
previousURL to the previous page
AutomatedRecipeTemplateTreeNode
idNode ID
titleNode title
levelDepth level in the tree (0 = root)
parent_idParent node ID (absent for root)
AutomatedRecipeTemplateTreeStructure
Node in the template dependency tree
AutomatedRecipeTemplateDetail
idTemplate ID
titleTemplate title
descriptionTemplate description
List of data sources used by this template
Tree structure showing template dependencies
dependencies_countNumber of dependencies in the template
created_atTemplate creation timestamp
updated_atTemplate last update timestamp
AutomatedRecipe
recipe_idUnique recipe identifier (numeric string)
template_idID of the template this recipe was created from
template_titleTitle of the source template
titleRecipe title
stateCurrent recipe state
workspace_idWorkspace ID
created_atRecipe creation timestamp
updated_atRecipe last update timestamp
PaginatedAutomatedRecipeList
countTotal number of recipes
nextURL to the next page
previousURL to the previous page
AutomatedRecipeCreateResponse
recipe_idUnique recipe identifier (numeric string)
template_idID of the template this recipe was created from
titleRecipe title
stateInitial recipe state (typically "Extracting Data")
AutomatedRecipeConnectionAccount
idAccount ID
account_idExternal account identifier
AutomatedRecipeConnection
connection_idConnection ID
connection_data_sourceData source name for this connection
List of accounts for this connection
AutomatedRecipeDetail
recipe_idUnique recipe identifier (numeric string)
template_idID of the template this recipe was created from
datatable_idAssociated data table ID (null if not yet created)
titleRecipe title
stateCurrent recipe state
data_sourcesList of configured data source names
allowed_data_sourcesList of allowed data source names for this recipe
List of configured connections
sync_from_dateStart date for data synchronization
last_build_atLast successful build timestamp
created_atRecipe creation timestamp
updated_atRecipe last update timestamp

