Data
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
POST | |
PATCH | |
POST | |
POST | |
GET | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
POST |
List all external data sources
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:readPath parameters
- project_idstring
Query parameters
- limitinteger
- offsetinteger
- searchstring
Response
Example request
GET /api /environments /:project_id /external_data_sourcesExample response
Status 200
Create external data sources
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writePath parameters
- project_idstring
Request parameters
- client_secretstring
- account_idstring
- descriptionstring
- job_inputs
Response
Example request
POST /api /environments /:project_id /external_data_sourcesExample response
Status 201
Retrieve external data sources
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:readPath parameters
- idstring
- project_idstring
Response
Example request
GET /api /environments /:project_id /external_data_sources /:idExample response
Status 200
Update external data sources
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writePath parameters
- idstring
- project_idstring
Request parameters
- client_secretstring
- account_idstring
- descriptionstring
- job_inputs
Response
Example request
PATCH /api /environments /:project_id /external_data_sources /:idExample response
Status 200
Delete external data sources
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writePath parameters
- idstring
- project_idstring
Example request
DELETE /api /environments /:project_id /external_data_sources /:idExample response
Status 204 No response body
Retrieve external data sources jobs
Create, Read, Update and Delete External data Sources.
Path parameters
- idstring
- project_idstring
Example request
GET /api /environments /:project_id /external_data_sources /:id /jobsExample response
Status 200 No response body
Create external data sources reload
Create, Read, Update and Delete External data Sources.
Path parameters
- idstring
- project_idstring
Request parameters
- client_secretstring
- account_idstring
- descriptionstring
- job_inputs
Example request
POST /api /environments /:project_id /external_data_sources /:id /reloadExample response
Status 200 No response body
Update external data sources revenue analytics config
Update the revenue analytics configuration and return the full external data source.
Path parameters
- idstring
- project_idstring
Request parameters
- client_secretstring
- account_idstring
- descriptionstring
- job_inputs
Example request
PATCH /api /environments /:project_id /external_data_sources /:id /revenue_analytics_configExample response
Status 200 No response body
Create external data sources database schema
Create, Read, Update and Delete External data Sources.
Path parameters
- project_idstring
Request parameters
- client_secretstring
- account_idstring
- descriptionstring
- job_inputs
Example request
POST /api /environments /:project_id /external_data_sources /database_schemaExample response
Status 200 No response body
Create external data sources source prefix
Create, Read, Update and Delete External data Sources.
Path parameters
- project_idstring
Request parameters
- client_secretstring
- account_idstring
- descriptionstring
- job_inputs
Example request
POST /api /environments /:project_id /external_data_sources /source_prefixExample response
Status 200 No response body
Retrieve external data sources wizard
Create, Read, Update and Delete External data Sources.
Path parameters
- project_idstring
Example request
GET /api /environments /:project_id /external_data_sources /wizardExample response
Status 200 No response body
List all warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view:readPath parameters
- project_idstring
Query parameters
- pageinteger
- searchstring
Response
Example request
GET /api /environments /:project_id /warehouse_saved_queriesExample response
Status 200
Create warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view:writePath parameters
- project_idstring
Request parameters
- deletedboolean
- namestring
- query
- edited_history_idstring
- soft_updateboolean
Response
Example request
POST /api /environments /:project_id /warehouse_saved_queriesExample response
Status 201
Retrieve warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view:readPath parameters
- idstring
- project_idstring
Response
Example request
GET /api /environments /:project_id /warehouse_saved_queries /:idExample response
Status 200
Update warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view:writePath parameters
- idstring
- project_idstring
Request parameters
- deletedboolean
- namestring
- query
- edited_history_idstring
- soft_updateboolean
Response
Example request
PATCH /api /environments /:project_id /warehouse_saved_queries /:idExample response
Status 200
Delete warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view:writePath parameters
- idstring
- project_idstring
Example request
DELETE /api /environments /:project_id /warehouse_saved_queries /:idExample response
Status 204 No response body
Retrieve warehouse saved queries activity
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
activity_log:readPath parameters
- idstring
- project_idstring
Response
Example request
GET /api /environments /:project_id /warehouse_saved_queries /:id /activityExample response
Status 200
Create warehouse saved queries ancestors
Return the ancestors of this saved query.
By default, we return the immediate parents. The level parameter can be used to
look further back into the ancestor tree. If level overshoots (i.e. points to only
ancestors beyond the root), we return an empty list.
Path parameters
- idstring
- project_idstring
Request parameters
- deletedboolean
- namestring
- query
- edited_history_idstring
- soft_updateboolean
Response
Example request
POST /api /environments /:project_id /warehouse_saved_queries /:id /ancestors