Data
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
PATCH | |
DELETE | |
POST | |
GET | |
POST | |
DELETE | |
POST | |
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
GET |
Retrieve data warehouse check database name
Check if a database name is available.
Query parameters
- namestring
Response
Example request
GET /api /projects /:project_id /data_warehouse /check-database-nameExample response
Status 200
Retrieve data warehouse check schema name
Check if a schema name is free within the organization's managed warehouse.
Query parameters
- namestring
Response
Example request
GET /api /projects /:project_id /data_warehouse /check-schema-nameExample response
Status 200
Retrieve data warehouse completed activity
Returns completed/non-running activities (jobs with status 'Completed'). Supports pagination and cutoff time filtering.
Query parameters
- cutoff_daysintegerDefault:
30 - kindstringDefault:
allOne of:"all""import""model" - limitintegerDefault:
20 - offsetintegerDefault:
0 - outcomestringDefault:
completedOne of:"completed""failed""all"
Response
Example request
GET /api /projects /:project_id /data_warehouse /completed_activityExample response
Status 200
Status 500 The activity query failed.
Retrieve data warehouse data health issues
Returns failed/disabled data pipeline items for the Pipeline status side panel. Includes: materializations, syncs, sources, destinations, and transformations.
Required API key scopes
warehouse_view:readexternal_data_source:readbatch_export:readhog_function:readResponse
Example request
GET /api /projects /:project_id /data_warehouse /data_health_issuesExample response
Status 200
Status 500 The health query failed.
Retrieve data warehouse data ops dashboard
Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet.
Required API key scopes
warehouse_view:writeExample request
GET /api /projects /:project_id /data_warehouse /data_ops_dashboardExample response
Status 200 No response body
Retrieve data warehouse data quality gate
Read or update the team's data quality gate: whether a materialization whose error-severity checks fail is published.
Required API key scopes
warehouse_view:writeResponse
Example request
GET /api /projects /:project_id /data_warehouse /data_quality_gateExample response
Status 200
Update data warehouse data quality gate
Read or update the team's data quality gate: whether a materialization whose error-severity checks fail is published.
Required API key scopes
warehouse_view:writeRequest parameters
- gate_materialization_on_checksboolean
Response
Example request
PATCH /api /projects /:project_id /data_warehouse /data_quality_gateExample response
Status 200
Delete data warehouse delete org
Remove the organization's provisioning record after teardown, freeing its warehouse name.
Called once the warehouse status reports deleted: deprovision tears the warehouse
down, this removes the now-empty org row so the database_name can be reused. Restricted
to organization admins.
Required API key scopes
warehouse_view:writeResponse
Example request
DELETE /api /projects /:project_id /data_warehouse /delete-orgExample response
Status 200
Create data warehouse deprovision
Start deprovisioning the organization's managed warehouse. Restricted to organization admins.
Required API key scopes
warehouse_view:writeResponse
Example request
POST /api /projects /:project_id /data_warehouse /deprovisionExample response
Status 202
Retrieve data warehouse hoglake credentials
The organization's live hoglake OAuth credentials (never their secrets), and where to use them.
Required API key scopes
warehouse_view:readResponse
Example request
GET /api /projects /:project_id /data_warehouse /hoglake_credentialsExample response
Status 200
Create data warehouse hoglake credentials
Create an OAuth client credential for the managed hoglake catalog. The secret is in this response only.
Required API key scopes
warehouse_view:writeRequest parameters
- namestring
- scope
- ttl_secondsinteger
Response
Example request
POST /api /projects /:project_id /data_warehouse /hoglake_credentialsExample response
Status 201
Delete data warehouse hoglake credentials
Revoke the credential now: new tokens are refused and its S3 vends stop.
Required API key scopes
warehouse_view:writePath parameters
- credential_idstring
Response
Example request
DELETE /api /projects /:project_id /data_warehouse /hoglake_credentials /:credential_idExample response
Status 200
Create data warehouse hoglake credentials rotate
Replace the credential's secret; the old one stops working. The new secret is in this response only.
Required API key scopes
warehouse_view:writePath parameters
- credential_idstring
Response
Example request
POST /api /projects /:project_id /data_warehouse /hoglake_credentials /:credential_id /rotateExample response
Status 200
Retrieve data warehouse job stats
Returns success and failed job statistics for the last 1, 7, or 30 days. Query parameter 'days' can be 1, 7, or 30 (default: 7).
Query parameters
- daysintegerDefault:
7One of:"1""7""30"
Response
Example request
GET /api /projects /:project_id /data_warehouse /job_statsExample response
Status 200
Status 400 `days` was not 1, 7 or 30.
Status 500 The statistics query failed.
Retrieve data warehouse managed warehouse data status
Get events, persons, and imported source readiness for the managed warehouse.
Required API key scopes
warehouse_view:readexternal_data_source:readResponse
Example request
GET /api /projects /:project_id /data_warehouse /managed-warehouse-data-statusExample response
Status 200
Retrieve data warehouse managed warehouse monitoring
Get tenant-safe live worker, session, queue, and capacity data for the current organization.
Required API key scopes
warehouse_view:readResponse
Example request
GET /api /projects /:project_id /data_warehouse /managed-warehouse-monitoringExample response
Status 200 Current organization-scoped worker and query activity.
Status 400 The monitoring query parameters are invalid.
Status 403 Managed warehouse monitoring is not available to the caller.
Status 404 The organization does not have a managed warehouse, or this endpoint does not match its query engine.
Status 501 Managed warehouse monitoring is not configured.
Status 502 The managed warehouse monitoring service returned an invalid response or was unreachable.
Status 504 The managed warehouse monitoring service timed out.
Retrieve data warehouse managed warehouse monitoring timeseries
Get one allow-listed monitoring metric for the current organization and trailing time window.
Required API key scopes
warehouse_view:readQuery parameters
- metricstringOne of:
"query_rate""error_ratio""duration_p50""duration_p95""sessions_active""acquire_p95""acquire_by_source""storage_bytes""worker_crash_rate" - windowstringDefault:
24hOne of:"1h""6h""24h""7d""30d"
Response
Example request
GET /api /projects /:project_id /data_warehouse /managed-warehouse-monitoring-timeseriesExample response
Status 200 One organization-scoped monitoring metric over time.
Status 400 The monitoring query parameters are invalid.
Status 403 Managed warehouse monitoring is not available to the caller.
Status 404 The organization does not have a managed warehouse, or this endpoint does not match its query engine.
Status 501 Managed warehouse monitoring is not configured.
Status 502 The managed warehouse monitoring service returned an invalid response or was unreachable.
Status 504 The managed warehouse monitoring service timed out.
Retrieve data warehouse managed warehouse source schemas
Per-schema backfill and live import status for one source, for the Overview tab's drill-down modal — the main status endpoint only returns a per-source rollup.
Required API key scopes
warehouse_view:readexternal_data_source:readQuery parameters
- source_idstring
Response
Example request
GET /api /projects /:project_id /data_warehouse /managed-warehouse-source-schemasExample response
Status 200
Retrieve data warehouse managed warehouse trino monitoring
Get tenant-safe live Trino query totals, limits, and in-flight queries for the current organization.
Required API key scopes
warehouse_view:readResponse
Example request
GET /api /projects /:project_id /data_warehouse /managed-warehouse-trino-monitoringExample response
Status 200 Current organization-scoped Trino query activity.
Status 400 The monitoring query parameters are invalid.
Status 403 Managed warehouse monitoring is not available to the caller.
Status 404 The organization does not have a managed warehouse, or this endpoint does not match its query engine.
Status 501 Managed warehouse monitoring is not configured.
Status 502 The managed warehouse monitoring service returned an invalid response or was unreachable.
Status 504 The managed warehouse monitoring service timed out.
Retrieve data warehouse managed warehouse trino monitoring timeseries
Get one allow-listed Trino monitoring metric for the current organization and trailing time window.
Required API key scopes
warehouse_view:readQuery parameters
- metricstringOne of:
"queries_in_flight""query_rate""error_ratio""duration_p50""duration_p95""queue_time_p95""scanned_bytes_rate""cpu_seconds_rate""storage_bytes" - windowstringDefault:
24hOne of:"1h""6h""24h""7d""30d"
Response
Example request
GET /api /projects /:project_id /data_warehouse /managed-warehouse-trino-monitoring-timeseries




