{ "opencollection": "1.0.0", "info": { "name": "PostHog actions warehouse_saved_queries API", "version": "1.0.0" }, "items": [ { "info": { "name": "warehouse_saved_queries", "type": "folder" }, "items": [ { "info": { "name": "environments_warehouse_saved_queries_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/activity/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_ancestors_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/ancestors/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return the ancestors of this saved query.\n\nBy default, we return the immediate parents. The `level` parameter can be used to\nlook further back into the ancestor tree. If `level` overshoots (i.e. points to only\nancestors beyond the root), we return an empty list." }, { "info": { "name": "environments_warehouse_saved_queries_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/cancel/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel a running saved query workflow." }, { "info": { "name": "environments_warehouse_saved_queries_dependencies_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/dependencies/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ] }, "docs": "Return the count of immediate upstream and downstream dependencies for this saved query." }, { "info": { "name": "environments_warehouse_saved_queries_descendants_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/descendants/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return the descendants of this saved query.\n\nBy default, we return the immediate children. The `level` parameter can be used to\nlook further ahead into the descendants tree. If `level` overshoots (i.e. points to only\ndescendants further than a leaf), we return an empty list." }, { "info": { "name": "environments_warehouse_saved_queries_materialize_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/materialize/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Enable materialization for this saved query with a 24-hour sync frequency." }, { "info": { "name": "environments_warehouse_saved_queries_revert_materialization_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/revert_materialization/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Undo materialization, revert back to the original view.\n(i.e. delete the materialized table and the schedule)" }, { "info": { "name": "environments_warehouse_saved_queries_run_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/run/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Run this saved query." }, { "info": { "name": "environments_warehouse_saved_queries_run_history_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/run_history/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return the recent run history (up to 5 most recent) for this materialized view." }, { "info": { "name": "environments_warehouse_saved_queries_resume_schedules_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/resume_schedules/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume paused materialization schedules for multiple matviews.\n\nAccepts a list of view IDs in the request body: {\"view_ids\": [\"id1\", \"id2\", ...]}\nThis endpoint is idempotent - calling it on already running or non-existent schedules is safe." }, { "info": { "name": "warehouse_saved_queries_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/activity/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_ancestors_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/ancestors/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return the ancestors of this saved query.\n\nBy default, we return the immediate parents. The `level` parameter can be used to\nlook further back into the ancestor tree. If `level` overshoots (i.e. points to only\nancestors beyond the root), we return an empty list." }, { "info": { "name": "warehouse_saved_queries_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/cancel/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel a running saved query workflow." }, { "info": { "name": "warehouse_saved_queries_dependencies_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/dependencies/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ] }, "docs": "Return the count of immediate upstream and downstream dependencies for this saved query." }, { "info": { "name": "warehouse_saved_queries_descendants_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/descendants/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return the descendants of this saved query.\n\nBy default, we return the immediate children. The `level` parameter can be used to\nlook further ahead into the descendants tree. If `level` overshoots (i.e. points to only\ndescendants further than a leaf), we return an empty list." }, { "info": { "name": "warehouse_saved_queries_materialize_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/materialize/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Enable materialization for this saved query with a 24-hour sync frequency." }, { "info": { "name": "warehouse_saved_queries_revert_materialization_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/revert_materialization/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Undo materialization, revert back to the original view.\n(i.e. delete the materialized table and the schedule)" }, { "info": { "name": "warehouse_saved_queries_run_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/run/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Run this saved query." }, { "info": { "name": "warehouse_saved_queries_run_history_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/run_history/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return the recent run history (up to 5 most recent) for this materialized view." }, { "info": { "name": "warehouse_saved_queries_resume_schedules_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/resume_schedules/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume paused materialization schedules for multiple matviews.\n\nAccepts a list of view IDs in the request body: {\"view_ids\": [\"id1\", \"id2\", ...]}\nThis endpoint is idempotent - calling it on already running or non-existent schedules is safe." } ] } ], "bundled": true }