How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PostHog data_warehouse API

The data_warehouse API from PostHog — 110 operation(s) for data_warehouse.

PostHog data_warehouse API is one of 139 APIs that PostHog publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Data Warehouse. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 148 operations across 110 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.posthog.com/api.

148 operations 110 paths 47 schemas 12 DELETE60 GET14 PATCH54 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.posthog.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

PostHog data_warehouse API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PersonalAPIKeyAuth).

Paths & Operations 148

Across 110 paths, the API surfaces 148 operations — 12 DELETE, 60 GET, 14 PATCH, 54 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

data_warehouse 148
GET
/api/environments/{environment_id}/data_modeling_jobs/deprecated
List data modeling jobs which are "runs" for our saved queries.
environments_data_modeling_jobs_list 4 params → 200
GET
/api/environments/{environment_id}/data_modeling_jobs/{id}/deprecated
List data modeling jobs which are "runs" for our saved queries.
environments_data_modeling_jobs_retrieve 2 params → 200
GET
/api/environments/{environment_id}/data_modeling_jobs/recent/deprecated
Get the most recent non-running job for each saved query from the v2 backend.
environments_data_modeling_jobs_recent_retrieve 1 param → 200
GET
/api/environments/{environment_id}/data_modeling_jobs/running/deprecated
Get all currently running jobs from the v2 backend.
environments_data_modeling_jobs_running_retrieve 1 param → 200
GET
/api/environments/{environment_id}/data_warehouse/check-database-name/deprecated
Check if a database name is available.
environments_data_warehouse_check_database_name_retrieve 2 params → 200
GET
/api/environments/{environment_id}/data_warehouse/completed_activity/deprecated
Returns completed/non-running activities (jobs with status 'Completed'). Supports pagination and cutoff time filtering.
environments_data_warehouse_completed_activity_retrieve 1 param → 200
GET
/api/environments/{environment_id}/data_warehouse/data_health_issues/deprecated
Returns failed/disabled data pipeline items for the Pipeline status side panel. Includes: materializations, syncs, sources, destinations, and transformations.
environments_data_warehouse_data_health_issues_retrieve 1 param → 200
GET
/api/environments/{environment_id}/data_warehouse/data_ops_dashboard/deprecated
Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet.
environments_data_warehouse_data_ops_dashboard_retrieve 1 param → 200
POST
/api/environments/{environment_id}/data_warehouse/deprovision/deprecated
Start deprovisioning the managed warehouse for this team.
environments_data_warehouse_deprovision_create 1 param → 200
GET
/api/environments/{environment_id}/data_warehouse/job_stats/deprecated
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).
environments_data_warehouse_job_stats_retrieve 1 param → 200
GET
/api/environments/{environment_id}/data_warehouse/property_values/deprecated
API endpoints for data warehouse aggregate statistics and operations.
environments_data_warehouse_property_values_retrieve 1 param → 200
POST
/api/environments/{environment_id}/data_warehouse/provision/deprecated
Start provisioning a managed warehouse for this team.
environments_data_warehouse_provision_create 1 param body → 200
POST
/api/environments/{environment_id}/data_warehouse/reset-password/deprecated
Reset the root password for the managed warehouse.
environments_data_warehouse_reset_password_create 1 param → 200
GET
/api/environments/{environment_id}/data_warehouse/running_activity/deprecated
Returns currently running activities (jobs with status 'Running'). Supports pagination and cutoff time filtering.
environments_data_warehouse_running_activity_retrieve 1 param → 200
GET
/api/environments/{environment_id}/data_warehouse/total_rows_stats/deprecated
Returns aggregated statistics for the data warehouse total rows processed within the current billing period. Used by the frontend data warehouse scene to display usage information.
environments_data_warehouse_total_rows_stats_retrieve 1 param → 200
GET
/api/environments/{environment_id}/data_warehouse/warehouse_status/deprecated
Get the current provisioning status of the managed warehouse.
environments_data_warehouse_warehouse_status_retrieve 1 param → 200
GET
/api/environments/{environment_id}/external_data_schemas/deprecated
environments_external_data_schemas_list 4 params → 200
POST
/api/environments/{environment_id}/external_data_schemas/deprecated
environments_external_data_schemas_create 1 param body → 201
GET
/api/environments/{environment_id}/external_data_schemas/{id}/deprecated
environments_external_data_schemas_retrieve 2 params → 200
PUT
/api/environments/{environment_id}/external_data_schemas/{id}/deprecated
environments_external_data_schemas_update 2 params body → 200
PATCH
/api/environments/{environment_id}/external_data_schemas/{id}/deprecated
environments_external_data_schemas_partial_update 2 params body → 200
DELETE
/api/environments/{environment_id}/external_data_schemas/{id}/deprecated
environments_external_data_schemas_destroy 2 params → 204
POST
/api/environments/{environment_id}/external_data_schemas/{id}/cancel/deprecated
environments_external_data_schemas_cancel_create 2 params body → 200
DELETE
/api/environments/{environment_id}/external_data_schemas/{id}/delete_data/deprecated
environments_external_data_schemas_delete_data_destroy 2 params → 204
POST
/api/environments/{environment_id}/external_data_schemas/{id}/incremental_fields/deprecated
environments_external_data_schemas_incremental_fields_create 2 params body → 200
POST
/api/environments/{environment_id}/external_data_schemas/{id}/reload/deprecated
environments_external_data_schemas_reload_create 2 params body → 200
POST
/api/environments/{environment_id}/external_data_schemas/{id}/resync/deprecated
environments_external_data_schemas_resync_create 2 params body → 200
GET
/api/environments/{environment_id}/external_data_sources/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_list 4 params → 200
POST
/api/environments/{environment_id}/external_data_sources/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_create 1 param body → 201
GET
/api/environments/{environment_id}/external_data_sources/{id}/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_retrieve 2 params → 200
PUT
/api/environments/{environment_id}/external_data_sources/{id}/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_update 2 params body → 200
PATCH
/api/environments/{environment_id}/external_data_sources/{id}/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_partial_update 2 params body → 200
DELETE
/api/environments/{environment_id}/external_data_sources/{id}/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_destroy 2 params → 204
PATCH
/api/environments/{environment_id}/external_data_sources/{id}/bulk_update_schemas/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_bulk_update_schemas_partial_update 5 params body → 200
POST
/api/environments/{environment_id}/external_data_sources/{id}/create_webhook/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_create_webhook_create 2 params body → 200
POST
/api/environments/{environment_id}/external_data_sources/{id}/delete_webhook/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_delete_webhook_create 2 params body → 200
GET
/api/environments/{environment_id}/external_data_sources/{id}/jobs/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_jobs_retrieve 2 params → 200
POST
/api/environments/{environment_id}/external_data_sources/{id}/refresh_schemas/deprecated
Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync).
environments_external_data_sources_refresh_schemas_create 2 params body → 200
POST
/api/environments/{environment_id}/external_data_sources/{id}/reload/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_reload_create 2 params body → 200
PATCH
/api/environments/{environment_id}/external_data_sources/{id}/revenue_analytics_config/deprecated
Update the revenue analytics configuration and return the full external data source.
environments_external_data_sources_revenue_analytics_config_partial_update 2 params body → 200
POST
/api/environments/{environment_id}/external_data_sources/{id}/update_webhook_inputs/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_update_webhook_inputs_create 2 params body → 200
GET
/api/environments/{environment_id}/external_data_sources/{id}/webhook_info/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_webhook_info_retrieve 2 params → 200
POST
/api/environments/{environment_id}/external_data_sources/check_cdc_prerequisites/deprecated
Validate CDC prerequisites against a live Postgres connection. Used by the source wizard to surface ✅/❌ checks before source creation, and by the self-managed setup popup to verify user-created publi…
environments_external_data_sources_check_cdc_prerequisites_create 1 param → 200400
GET
/api/environments/{environment_id}/external_data_sources/connections/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_connections_list 4 params → 200
POST
/api/environments/{environment_id}/external_data_sources/database_schema/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_database_schema_create 1 param body → 200
POST
/api/environments/{environment_id}/external_data_sources/source_prefix/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_source_prefix_create 1 param body → 200
GET
/api/environments/{environment_id}/external_data_sources/wizard/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_wizard_retrieve 1 param → 200
GET
/api/environments/{environment_id}/insight_variables/deprecated
environments_insight_variables_list 2 params → 200
POST
/api/environments/{environment_id}/insight_variables/deprecated
environments_insight_variables_create 1 param body → 201
GET
/api/environments/{environment_id}/insight_variables/{id}/deprecated
environments_insight_variables_retrieve 2 params → 200
PUT
/api/environments/{environment_id}/insight_variables/{id}/deprecated
environments_insight_variables_update 2 params body → 200
PATCH
/api/environments/{environment_id}/insight_variables/{id}/deprecated
environments_insight_variables_partial_update 2 params body → 200
DELETE
/api/environments/{environment_id}/insight_variables/{id}/deprecated
environments_insight_variables_destroy 2 params → 204
GET
/api/environments/{environment_id}/warehouse_saved_queries/deprecated
Create, Read, Update and Delete Warehouse Tables.
environments_warehouse_saved_queries_list 3 params → 200
POST
/api/environments/{environment_id}/warehouse_saved_queries/deprecated
Create, Read, Update and Delete Warehouse Tables.
environments_warehouse_saved_queries_create 1 param body → 201
GET
/api/environments/{environment_id}/warehouse_saved_queries/{id}/deprecated
Create, Read, Update and Delete Warehouse Tables.
environments_warehouse_saved_queries_retrieve 2 params → 200
PUT
/api/environments/{environment_id}/warehouse_saved_queries/{id}/deprecated
Create, Read, Update and Delete Warehouse Tables.
environments_warehouse_saved_queries_update 2 params body → 200
PATCH
/api/environments/{environment_id}/warehouse_saved_queries/{id}/deprecated
Create, Read, Update and Delete Warehouse Tables.
environments_warehouse_saved_queries_partial_update 2 params body → 200
DELETE
/api/environments/{environment_id}/warehouse_saved_queries/{id}/deprecated
Create, Read, Update and Delete Warehouse Tables.
environments_warehouse_saved_queries_destroy 2 params → 204
GET
/api/environments/{environment_id}/warehouse_saved_queries/{id}/activity/deprecated
Create, Read, Update and Delete Warehouse Tables.
environments_warehouse_saved_queries_activity_retrieve 2 params → 200
POST
/api/environments/{environment_id}/warehouse_saved_queries/{id}/ancestors/deprecated
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…
environments_warehouse_saved_queries_ancestors_create 2 params body → 200
POST
/api/environments/{environment_id}/warehouse_saved_queries/{id}/cancel/deprecated
Cancel a running saved query workflow.
environments_warehouse_saved_queries_cancel_create 2 params body → 200
GET
/api/environments/{environment_id}/warehouse_saved_queries/{id}/dependencies/deprecated
Return the count of immediate upstream and downstream dependencies for this saved query.
environments_warehouse_saved_queries_dependencies_retrieve 2 params → 200
POST
/api/environments/{environment_id}/warehouse_saved_queries/{id}/descendants/deprecated
Return the descendants of this saved query. By default, we return the immediate children. The level parameter can be used to look further ahead into the descendants tree. If level overshoots (i.e. po…
environments_warehouse_saved_queries_descendants_create 2 params body → 200
POST
/api/environments/{environment_id}/warehouse_saved_queries/{id}/materialize/deprecated
Enable materialization for this saved query with a 24-hour sync frequency.
environments_warehouse_saved_queries_materialize_create 2 params body → 200
POST
/api/environments/{environment_id}/warehouse_saved_queries/{id}/revert_materialization/deprecated
Undo materialization, revert back to the original view. (i.e. delete the materialized table and the schedule)
environments_warehouse_saved_queries_revert_materialization_create 2 params body → 200
POST
/api/environments/{environment_id}/warehouse_saved_queries/{id}/run/deprecated
Run this saved query.
environments_warehouse_saved_queries_run_create 2 params body → 200
GET
/api/environments/{environment_id}/warehouse_saved_queries/{id}/run_history/deprecated
Return the recent run history (up to 5 most recent) for this materialized view.
environments_warehouse_saved_queries_run_history_retrieve 2 params → 200
POST
/api/environments/{environment_id}/warehouse_saved_queries/resume_schedules/deprecated
Resume paused materialization schedules for multiple matviews. Accepts a list of view IDs in the request body: {"viewids": ["id1", "id2", ...]} This endpoint is idempotent - calling it on already run…
environments_warehouse_saved_queries_resume_schedules_create 1 param body → 200
GET
/api/environments/{environment_id}/warehouse_saved_query_folders/deprecated
environments_warehouse_saved_query_folders_list 1 param → 200
POST
/api/environments/{environment_id}/warehouse_saved_query_folders/deprecated
environments_warehouse_saved_query_folders_create 1 param body → 201
GET
/api/environments/{environment_id}/warehouse_saved_query_folders/{id}/deprecated
environments_warehouse_saved_query_folders_retrieve 2 params → 200
PATCH
/api/environments/{environment_id}/warehouse_saved_query_folders/{id}/deprecated
environments_warehouse_saved_query_folders_partial_update 2 params body → 200
DELETE
/api/environments/{environment_id}/warehouse_saved_query_folders/{id}/deprecated
environments_warehouse_saved_query_folders_destroy 2 params → 204
GET
/api/projects/{project_id}/data_modeling_jobs/
List data modeling jobs which are "runs" for our saved queries.
data_modeling_jobs_list 4 params → 200
GET
/api/projects/{project_id}/data_modeling_jobs/{id}/
List data modeling jobs which are "runs" for our saved queries.
data_modeling_jobs_retrieve 2 params → 200
GET
/api/projects/{project_id}/data_modeling_jobs/recent/
Get the most recent non-running job for each saved query from the v2 backend.
data_modeling_jobs_recent_retrieve 1 param → 200
GET
/api/projects/{project_id}/data_modeling_jobs/running/
Get all currently running jobs from the v2 backend.
data_modeling_jobs_running_retrieve 1 param → 200
GET
/api/projects/{project_id}/data_warehouse/check-database-name/
Check if a database name is available.
data_warehouse_check_database_name_retrieve 2 params → 200
GET
/api/projects/{project_id}/data_warehouse/completed_activity/
Returns completed/non-running activities (jobs with status 'Completed'). Supports pagination and cutoff time filtering.
data_warehouse_completed_activity_retrieve 1 param → 200
GET
/api/projects/{project_id}/data_warehouse/data_health_issues/
Returns failed/disabled data pipeline items for the Pipeline status side panel. Includes: materializations, syncs, sources, destinations, and transformations.
data_warehouse_data_health_issues_retrieve 1 param → 200
GET
/api/projects/{project_id}/data_warehouse/data_ops_dashboard/
Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet.
data_warehouse_data_ops_dashboard_retrieve 1 param → 200
POST
/api/projects/{project_id}/data_warehouse/deprovision/
Start deprovisioning the managed warehouse for this team.
data_warehouse_deprovision_create 1 param → 200
GET
/api/projects/{project_id}/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).
data_warehouse_job_stats_retrieve 1 param → 200
GET
/api/projects/{project_id}/data_warehouse/property_values/
API endpoints for data warehouse aggregate statistics and operations.
data_warehouse_property_values_retrieve 1 param → 200
POST
/api/projects/{project_id}/data_warehouse/provision/
Start provisioning a managed warehouse for this team.
data_warehouse_provision_create 1 param body → 200
POST
/api/projects/{project_id}/data_warehouse/reset-password/
Reset the root password for the managed warehouse.
data_warehouse_reset_password_create 1 param → 200
GET
/api/projects/{project_id}/data_warehouse/running_activity/
Returns currently running activities (jobs with status 'Running'). Supports pagination and cutoff time filtering.
data_warehouse_running_activity_retrieve 1 param → 200
GET
/api/projects/{project_id}/data_warehouse/total_rows_stats/
Returns aggregated statistics for the data warehouse total rows processed within the current billing period. Used by the frontend data warehouse scene to display usage information.
data_warehouse_total_rows_stats_retrieve 1 param → 200
GET
/api/projects/{project_id}/data_warehouse/warehouse_status/
Get the current provisioning status of the managed warehouse.
data_warehouse_warehouse_status_retrieve 1 param → 200
GET
/api/projects/{project_id}/external_data_schemas/
external_data_schemas_list 4 params → 200
POST
/api/projects/{project_id}/external_data_schemas/
external_data_schemas_create 1 param body → 201
GET
/api/projects/{project_id}/external_data_schemas/{id}/
external_data_schemas_retrieve 2 params → 200
PUT
/api/projects/{project_id}/external_data_schemas/{id}/
external_data_schemas_update 2 params body → 200
PATCH
/api/projects/{project_id}/external_data_schemas/{id}/
external_data_schemas_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/external_data_schemas/{id}/
external_data_schemas_destroy 2 params → 204
POST
/api/projects/{project_id}/external_data_schemas/{id}/cancel/
external_data_schemas_cancel_create 2 params body → 200
DELETE
/api/projects/{project_id}/external_data_schemas/{id}/delete_data/
external_data_schemas_delete_data_destroy 2 params → 204
POST
/api/projects/{project_id}/external_data_schemas/{id}/incremental_fields/
external_data_schemas_incremental_fields_create 2 params body → 200
POST
/api/projects/{project_id}/external_data_schemas/{id}/reload/
external_data_schemas_reload_create 2 params body → 200
POST
/api/projects/{project_id}/external_data_schemas/{id}/resync/
external_data_schemas_resync_create 2 params body → 200
GET
/api/projects/{project_id}/external_data_sources/
Create, Read, Update and Delete External data Sources.
external_data_sources_list 4 params → 200
POST
/api/projects/{project_id}/external_data_sources/
Create, Read, Update and Delete External data Sources.
external_data_sources_create 1 param body → 201
GET
/api/projects/{project_id}/external_data_sources/{id}/
Create, Read, Update and Delete External data Sources.
external_data_sources_retrieve 2 params → 200
PUT
/api/projects/{project_id}/external_data_sources/{id}/
Create, Read, Update and Delete External data Sources.
external_data_sources_update 2 params body → 200
PATCH
/api/projects/{project_id}/external_data_sources/{id}/
Create, Read, Update and Delete External data Sources.
external_data_sources_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/external_data_sources/{id}/
Create, Read, Update and Delete External data Sources.
external_data_sources_destroy 2 params → 204
PATCH
/api/projects/{project_id}/external_data_sources/{id}/bulk_update_schemas/
Create, Read, Update and Delete External data Sources.
external_data_sources_bulk_update_schemas_partial_update 5 params body → 200
POST
/api/projects/{project_id}/external_data_sources/{id}/create_webhook/
Create, Read, Update and Delete External data Sources.
external_data_sources_create_webhook_create 2 params body → 200
POST
/api/projects/{project_id}/external_data_sources/{id}/delete_webhook/
Create, Read, Update and Delete External data Sources.
external_data_sources_delete_webhook_create 2 params body → 200
GET
/api/projects/{project_id}/external_data_sources/{id}/jobs/
Create, Read, Update and Delete External data Sources.
external_data_sources_jobs_retrieve 2 params → 200
POST
/api/projects/{project_id}/external_data_sources/{id}/refresh_schemas/
Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync).
external_data_sources_refresh_schemas_create 2 params body → 200
POST
/api/projects/{project_id}/external_data_sources/{id}/reload/
Create, Read, Update and Delete External data Sources.
external_data_sources_reload_create 2 params body → 200
PATCH
/api/projects/{project_id}/external_data_sources/{id}/revenue_analytics_config/
Update the revenue analytics configuration and return the full external data source.
external_data_sources_revenue_analytics_config_partial_update 2 params body → 200
POST
/api/projects/{project_id}/external_data_sources/{id}/update_webhook_inputs/
Create, Read, Update and Delete External data Sources.
external_data_sources_update_webhook_inputs_create 2 params body → 200
GET
/api/projects/{project_id}/external_data_sources/{id}/webhook_info/
Create, Read, Update and Delete External data Sources.
external_data_sources_webhook_info_retrieve 2 params → 200
POST
/api/projects/{project_id}/external_data_sources/check_cdc_prerequisites/
Validate CDC prerequisites against a live Postgres connection. Used by the source wizard to surface ✅/❌ checks before source creation, and by the self-managed setup popup to verify user-created publi…
external_data_sources_check_cdc_prerequisites_create 1 param → 200400
GET
/api/projects/{project_id}/external_data_sources/connections/
Create, Read, Update and Delete External data Sources.
external_data_sources_connections_list 4 params → 200
POST
/api/projects/{project_id}/external_data_sources/database_schema/
Create, Read, Update and Delete External data Sources.
external_data_sources_database_schema_create 1 param body → 200
POST
/api/projects/{project_id}/external_data_sources/source_prefix/
Create, Read, Update and Delete External data Sources.
external_data_sources_source_prefix_create 1 param body → 200
GET
/api/projects/{project_id}/external_data_sources/wizard/
Create, Read, Update and Delete External data Sources.
external_data_sources_wizard_retrieve 1 param → 200
GET
/api/projects/{project_id}/insight_variables/
insight_variables_list 2 params → 200
POST
/api/projects/{project_id}/insight_variables/
insight_variables_create 1 param body → 201
GET
/api/projects/{project_id}/insight_variables/{id}/
insight_variables_retrieve 2 params → 200
PUT
/api/projects/{project_id}/insight_variables/{id}/
insight_variables_update 2 params body → 200
PATCH
/api/projects/{project_id}/insight_variables/{id}/
insight_variables_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/insight_variables/{id}/
insight_variables_destroy 2 params → 204
GET
/api/projects/{project_id}/warehouse_saved_queries/
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries_list 3 params → 200
POST
/api/projects/{project_id}/warehouse_saved_queries/
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries_create 1 param body → 201
GET
/api/projects/{project_id}/warehouse_saved_queries/{id}/
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries_retrieve 2 params → 200
PUT
/api/projects/{project_id}/warehouse_saved_queries/{id}/
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries_update 2 params body → 200
PATCH
/api/projects/{project_id}/warehouse_saved_queries/{id}/
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/warehouse_saved_queries/{id}/
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries_destroy 2 params → 204
GET
/api/projects/{project_id}/warehouse_saved_queries/{id}/activity/
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries_activity_retrieve 2 params → 200
POST
/api/projects/{project_id}/warehouse_saved_queries/{id}/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…
warehouse_saved_queries_ancestors_create 2 params body → 200
POST
/api/projects/{project_id}/warehouse_saved_queries/{id}/cancel/
Cancel a running saved query workflow.
warehouse_saved_queries_cancel_create 2 params body → 200
GET
/api/projects/{project_id}/warehouse_saved_queries/{id}/dependencies/
Return the count of immediate upstream and downstream dependencies for this saved query.
warehouse_saved_queries_dependencies_retrieve 2 params → 200
POST
/api/projects/{project_id}/warehouse_saved_queries/{id}/descendants/
Return the descendants of this saved query. By default, we return the immediate children. The level parameter can be used to look further ahead into the descendants tree. If level overshoots (i.e. po…
warehouse_saved_queries_descendants_create 2 params body → 200
POST
/api/projects/{project_id}/warehouse_saved_queries/{id}/materialize/
Enable materialization for this saved query with a 24-hour sync frequency.
warehouse_saved_queries_materialize_create 2 params body → 200
POST
/api/projects/{project_id}/warehouse_saved_queries/{id}/revert_materialization/
Undo materialization, revert back to the original view. (i.e. delete the materialized table and the schedule)
warehouse_saved_queries_revert_materialization_create 2 params body → 200
POST
/api/projects/{project_id}/warehouse_saved_queries/{id}/run/
Run this saved query.
warehouse_saved_queries_run_create 2 params body → 200
GET
/api/projects/{project_id}/warehouse_saved_queries/{id}/run_history/
Return the recent run history (up to 5 most recent) for this materialized view.
warehouse_saved_queries_run_history_retrieve 2 params → 200
POST
/api/projects/{project_id}/warehouse_saved_queries/resume_schedules/
Resume paused materialization schedules for multiple matviews. Accepts a list of view IDs in the request body: {"viewids": ["id1", "id2", ...]} This endpoint is idempotent - calling it on already run…
warehouse_saved_queries_resume_schedules_create 1 param body → 200
GET
/api/projects/{project_id}/warehouse_saved_query_folders/
warehouse_saved_query_folders_list 1 param → 200
POST
/api/projects/{project_id}/warehouse_saved_query_folders/
warehouse_saved_query_folders_create 1 param body → 201
GET
/api/projects/{project_id}/warehouse_saved_query_folders/{id}/
warehouse_saved_query_folders_retrieve 2 params → 200
PATCH
/api/projects/{project_id}/warehouse_saved_query_folders/{id}/
warehouse_saved_query_folders_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/warehouse_saved_query_folders/{id}/
warehouse_saved_query_folders_destroy 2 params → 204

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are DataWarehouseSavedQuery (23 properties), PatchedDataWarehouseSavedQuery (23 properties), ExternalDataSourceSerializers (19 properties), PatchedExternalDataSourceSerializers (19 properties). Each schema is shown below with its type and property counts.

DatabaseSchemaRequest
object
Validate credentials and preview available tables from a remote database. The request body contains sourcetype plus flat source-specific credential fields (e.g…
1 property 1 required
ResetPasswordResponse
object
2 properties 2 required
PaginatedInsightVariableList
object
4 properties 2 required
CdcTableModeEnum
string
consolidated - consolidated cdconly - cdconly both - both
NullEnum
SyncFrequencyEnum
string
never - never 1min - 1min 5min - 5min 15min - 15min 30min - 30min 1hour - 1hour 6hour - 6hour 12hour - 12hour 24hour - 24hour 7day - 7day 30day - 30day
DataModelingJobStatusEnum
string
Cancelled - Cancelled Completed - Completed Failed - Failed Running - Running
PatchedDataWarehouseSavedQuery
object
Shared methods for DataWarehouseSavedQuery serializers. This mixin is intended to be used with serializers.ModelSerializer subclasses.
23 properties
SavedQueryStatusEnum
string
Cancelled - Cancelled Modified - Modified Completed - Completed Failed - Failed Running - Running
ProvisionWarehouseResponse
object
2 properties 2 required
ExternalDataSourceSerializers
object
Mixin for serializers to add user access control fields
19 properties 15 required
PaginatedExternalDataSchemaList
object
4 properties 2 required
PaginatedDataWarehouseSavedQueryMinimalList
object
4 properties 2 required
ExternalDataSourceConnectionOption
object
3 properties 3 required
PatchedExternalDataSourceBulkUpdateSchemas
object
1 property
ExternalDataSourceCreate
object
6 properties 2 required
DataWarehouseSavedQueryFolder
object
Mixin for serializers to add user access control fields
6 properties 6 required
PatchedExternalDataSchema
object
17 properties
ExternalDataSourceBulkUpdateSchema
object
8 properties 1 required
PatchedInsightVariable
object
8 properties
PatchedDataWarehouseSavedQueryFolder
object
Mixin for serializers to add user access control fields
6 properties
AccessMethodEnum
string
warehouse - warehouse direct - direct
InsightVariable
object
8 properties 6 required
DeprovisionWarehouseResponse
object
2 properties 2 required
IncrementalFieldTypeEnum
string
integer - integer numeric - numeric datetime - datetime date - date timestamp - timestamp objectid - objectid
ExternalDataSourceRevenueAnalyticsConfig
object
2 properties
WarehouseStatusResponseStateEnum
string
pending - pending provisioning - provisioning ready - ready failed - failed deleting - deleting deleted - deleted
DataModelingJob
object
10 properties 10 required
DataWarehouseSavedQuery
object
Shared methods for DataWarehouseSavedQuery serializers. This mixin is intended to be used with serializers.ModelSerializer subclasses.
23 properties 16 required
WarehouseStatusResponse
object
5 properties 5 required
OriginEnum
string
datawarehouse - Data Warehouse endpoint - Endpoint managedviewset - Managed Viewset
PaginatedExternalDataSourceSerializersList
object
4 properties 2 required
UserBasic
object
9 properties 4 required
InsightVariableTypeEnum
string
String - String Number - Number Boolean - Boolean List - List Date - Date
EngineEnum
string
duckdb - duckdb postgres - postgres
BlankEnum
CheckDatabaseNameResponse
object
2 properties 2 required
PatchedExternalDataSourceSerializers
object
Mixin for serializers to add user access control fields
19 properties
RoleAtOrganizationEnum
string
engineering - Engineering data - Data product - Product Management founder - Founder leadership - Leadership marketing - Marketing sales - Sales / Success othe…
SyncTypeEnum
string
fullrefresh - fullrefresh incremental - incremental append - append webhook - webhook cdc - cdc
CreatedViaEnum
string
web - web api - api mcp - mcp
PaginatedExternalDataSourceConnectionOptionList
object
4 properties 2 required
DataWarehouseSavedQueryMinimal
object
Lightweight serializer for list views - excludes large query field to reduce memory usage.
18 properties 18 required
ExternalDataSchema
object
17 properties 9 required
ExternalDataSourceTypeEnum
string
Ashby - Ashby Supabase - Supabase CustomerIO - CustomerIO Github - Github Stripe - Stripe Hubspot - Hubspot Postgres - Postgres Zendesk - Zendesk Snowflake - S…
ProvisionWarehouseRequest
object
1 property 1 required
PaginatedDataModelingJobList
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posthog-data-warehouse-api-openapi.yml Raw ↑

Other APIs PostHog publishes across the network.

PostHog Capture API
PostHog Query API
PostHog Persons API
PostHog Feature Flags API
PostHog Experiments API
PostHog Insights API
PostHog Cohorts API
PostHog Annotations API
PostHog actions API
PostHog activity_log API
PostHog activity_logs API
PostHog advanced_activity_logs API
Where this information came from

This is an independent, third-party profile of PostHog data_warehouse API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.