openapi: 3.0.3
info:
  title: PostHog actions data_warehouse API
  version: 1.0.0
  description: ''
tags:
- name: data_warehouse
paths:
  /api/environments/{environment_id}/data_modeling_jobs/:
    get:
      operationId: environments_data_modeling_jobs_list
      description: List data modeling jobs which are "runs" for our saved queries.
      parameters:
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: saved_query_id
        schema:
          type: string
          format: uuid
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDataModelingJobList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_modeling_jobs/{id}/:
    get:
      operationId: environments_data_modeling_jobs_retrieve
      description: List data modeling jobs which are "runs" for our saved queries.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data modeling job.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataModelingJob'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_modeling_jobs/recent/:
    get:
      operationId: environments_data_modeling_jobs_recent_retrieve
      description: Get the most recent non-running job for each saved query from the v2 backend.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataModelingJob'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_modeling_jobs/running/:
    get:
      operationId: environments_data_modeling_jobs_running_retrieve
      description: Get all currently running jobs from the v2 backend.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataModelingJob'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/check-database-name/:
    get:
      operationId: environments_data_warehouse_check_database_name_retrieve
      description: Check if a database name is available.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: name
        schema:
          type: string
          minLength: 1
        description: Database name to check
        required: true
      tags:
      - data_warehouse
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckDatabaseNameResponse'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/completed_activity/:
    get:
      operationId: environments_data_warehouse_completed_activity_retrieve
      description: 'Returns completed/non-running activities (jobs with status ''Completed'').

        Supports pagination and cutoff time filtering.'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/data_health_issues/:
    get:
      operationId: environments_data_warehouse_data_health_issues_retrieve
      description: 'Returns failed/disabled data pipeline items for the Pipeline status side panel.

        Includes: materializations, syncs, sources, destinations, and transformations.'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/data_ops_dashboard/:
    get:
      operationId: environments_data_warehouse_data_ops_dashboard_retrieve
      description: Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/deprovision/:
    post:
      operationId: environments_data_warehouse_deprovision_create
      description: Start deprovisioning the managed warehouse for this team.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeprovisionWarehouseResponse'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/job_stats/:
    get:
      operationId: environments_data_warehouse_job_stats_retrieve
      description: '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).'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/property_values/:
    get:
      operationId: environments_data_warehouse_property_values_retrieve
      description: API endpoints for data warehouse aggregate statistics and operations.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - query:read
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/provision/:
    post:
      operationId: environments_data_warehouse_provision_create
      description: Start provisioning a managed warehouse for this team.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProvisionWarehouseRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ProvisionWarehouseRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ProvisionWarehouseRequest'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisionWarehouseResponse'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/reset-password/:
    post:
      operationId: environments_data_warehouse_reset_password_create
      description: Reset the root password for the managed warehouse.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetPasswordResponse'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/running_activity/:
    get:
      operationId: environments_data_warehouse_running_activity_retrieve
      description: 'Returns currently running activities (jobs with status ''Running'').

        Supports pagination and cutoff time filtering.'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/total_rows_stats/:
    get:
      operationId: environments_data_warehouse_total_rows_stats_retrieve
      description: '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.'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/data_warehouse/warehouse_status/:
    get:
      operationId: environments_data_warehouse_warehouse_status_retrieve
      description: Get the current provisioning status of the managed warehouse.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WarehouseStatusResponse'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_schemas/:
    get:
      operationId: environments_external_data_schemas_list
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExternalDataSchemaList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    post:
      operationId: environments_external_data_schemas_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSchema'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_schemas/{id}/:
    get:
      operationId: environments_external_data_schemas_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSchema'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    put:
      operationId: environments_external_data_schemas_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSchema'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    patch:
      operationId: environments_external_data_schemas_partial_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSchema'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    delete:
      operationId: environments_external_data_schemas_destroy
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '204':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_schemas/{id}/cancel/:
    post:
      operationId: environments_external_data_schemas_cancel_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_schemas/{id}/delete_data/:
    delete:
      operationId: environments_external_data_schemas_delete_data_destroy
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '204':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_schemas/{id}/incremental_fields/:
    post:
      operationId: environments_external_data_schemas_incremental_fields_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_schemas/{id}/reload/:
    post:
      operationId: environments_external_data_schemas_reload_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_schemas/{id}/resync/:
    post:
      operationId: environments_external_data_schemas_resync_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/:
    get:
      operationId: environments_external_data_sources_list
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExternalDataSourceSerializersList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    post:
      operationId: environments_external_data_sources_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceCreate'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSourceSerializers'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/{id}/:
    get:
      operationId: environments_external_data_sources_retrieve
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSourceSerializers'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    put:
      operationId: environments_external_data_sources_update
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSourceSerializers'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    patch:
      operationId: environments_external_data_sources_partial_update
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSourceSerializers'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    delete:
      operationId: environments_external_data_sources_destroy
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '204':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/{id}/bulk_update_schemas/:
    patch:
      operationId: environments_external_data_sources_bulk_update_schemas_partial_update
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceBulkUpdateSchemas'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceBulkUpdateSchemas'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceBulkUpdateSchemas'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExternalDataSchemaList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/{id}/create_webhook/:
    post:
      operationId: environments_external_data_sources_create_webhook_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/{id}/delete_webhook/:
    post:
      operationId: environments_external_data_sources_delete_webhook_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/{id}/jobs/:
    get:
      operationId: environments_external_data_sources_jobs_retrieve
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/{id}/refresh_schemas/:
    post:
      operationId: environments_external_data_sources_refresh_schemas_create
      description: Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync).
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/{id}/reload/:
    post:
      operationId: environments_external_data_sources_reload_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/{id}/revenue_analytics_config/:
    patch:
      operationId: environments_external_data_sources_revenue_analytics_config_partial_update
      description: Update the revenue analytics configuration and return the full external data source.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/{id}/update_webhook_inputs/:
    post:
      operationId: environments_external_data_sources_update_webhook_inputs_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/{id}/webhook_info/:
    get:
      operationId: environments_external_data_sources_webhook_info_retrieve
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/check_cdc_prerequisites/:
    post:
      operationId: environments_external_data_sources_check_cdc_prerequisites_create
      description: '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 publications.'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  valid:
                    type: boolean
                  errors:
                    type: array
                    items:
                      type: string
          description: Whether the Postgres database satisfies CDC prerequisites.
        '400':
          description: Invalid config, disallowed host, or connection failure.
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/connections/:
    get:
      operationId: environments_external_data_sources_connections_list
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExternalDataSourceConnectionOptionList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/database_schema/:
    post:
      operationId: environments_external_data_sources_database_schema_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatabaseSchemaRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DatabaseSchemaRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DatabaseSchemaRequest'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/source_prefix/:
    post:
      operationId: environments_external_data_sources_source_prefix_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/external_data_sources/wizard/:
    get:
      operationId: environments_external_data_sources_wizard_retrieve
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/insight_variables/:
    get:
      operationId: environments_insight_variables_list
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedInsightVariableList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    post:
      operationId: environments_insight_variables_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightVariable'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/InsightVariable'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/InsightVariable'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightVariable'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/insight_variables/{id}/:
    get:
      operationId: environments_insight_variables_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this insight variable.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightVariable'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    put:
      operationId: environments_insight_variables_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this insight variable.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightVariable'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/InsightVariable'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/InsightVariable'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightVariable'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    patch:
      operationId: environments_insight_variables_partial_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this insight variable.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedInsightVariable'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedInsightVariable'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedInsightVariable'
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightVariable'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    delete:
      operationId: environments_insight_variables_destroy
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this insight variable.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:write
      responses:
        '204':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/:
    get:
      operationId: environments_warehouse_saved_queries_list
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDataWarehouseSavedQueryMinimalList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    post:
      operationId: environments_warehouse_saved_queries_create
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/{id}/:
    get:
      operationId: environments_warehouse_saved_queries_retrieve
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    put:
      operationId: environments_warehouse_saved_queries_update
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    patch:
      operationId: environments_warehouse_saved_queries_partial_update
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQuery'
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    delete:
      operationId: environments_warehouse_saved_queries_destroy
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '204':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/{id}/activity/:
    get:
      operationId: environments_warehouse_saved_queries_activity_retrieve
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - activity_log:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/{id}/ancestors/:
    post:
      operationId: environments_warehouse_saved_queries_ancestors_create
      description: '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.'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/{id}/cancel/:
    post:
      operationId: environments_warehouse_saved_queries_cancel_create
      description: Cancel a running saved query workflow.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/{id}/dependencies/:
    get:
      operationId: environments_warehouse_saved_queries_dependencies_retrieve
      description: Return the count of immediate upstream and downstream dependencies for this saved query.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/{id}/descendants/:
    post:
      operationId: environments_warehouse_saved_queries_descendants_create
      description: '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. points to only

        descendants further than a leaf), we return an empty list.'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/{id}/materialize/:
    post:
      operationId: environments_warehouse_saved_queries_materialize_create
      description: Enable materialization for this saved query with a 24-hour sync frequency.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/{id}/revert_materialization/:
    post:
      operationId: environments_warehouse_saved_queries_revert_materialization_create
      description: 'Undo materialization, revert back to the original view.

        (i.e. delete the materialized table and the schedule)'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/{id}/run/:
    post:
      operationId: environments_warehouse_saved_queries_run_create
      description: Run this saved query.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/{id}/run_history/:
    get:
      operationId: environments_warehouse_saved_queries_run_history_retrieve
      description: Return the recent run history (up to 5 most recent) for this materialized view.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_queries/resume_schedules/:
    post:
      operationId: environments_warehouse_saved_queries_resume_schedules_create
      description: 'Resume paused materialization schedules for multiple matviews.


        Accepts a list of view IDs in the request body: {"view_ids": ["id1", "id2", ...]}

        This endpoint is idempotent - calling it on already running or non-existent schedules is safe.'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_query_folders/:
    get:
      operationId: environments_warehouse_saved_query_folders_list
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    post:
      operationId: environments_warehouse_saved_query_folders_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/environments/{environment_id}/warehouse_saved_query_folders/{id}/:
    get:
      operationId: environments_warehouse_saved_query_folders_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query folder.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    patch:
      operationId: environments_warehouse_saved_query_folders_partial_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query folder.
        required: true
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQueryFolder'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQueryFolder'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQueryFolder'
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          description: ''
      deprecated: true
      x-explicit-tags:
      - data_warehouse
    delete:
      operationId: environments_warehouse_saved_query_folders_destroy
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query folder.
        required: true
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '204':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_modeling_jobs/:
    get:
      operationId: data_modeling_jobs_list
      description: List data modeling jobs which are "runs" for our saved queries.
      parameters:
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: query
        name: saved_query_id
        schema:
          type: string
          format: uuid
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDataModelingJobList'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_modeling_jobs/{id}/:
    get:
      operationId: data_modeling_jobs_retrieve
      description: List data modeling jobs which are "runs" for our saved queries.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data modeling job.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataModelingJob'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_modeling_jobs/recent/:
    get:
      operationId: data_modeling_jobs_recent_retrieve
      description: Get the most recent non-running job for each saved query from the v2 backend.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataModelingJob'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_modeling_jobs/running/:
    get:
      operationId: data_modeling_jobs_running_retrieve
      description: Get all currently running jobs from the v2 backend.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataModelingJob'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/check-database-name/:
    get:
      operationId: data_warehouse_check_database_name_retrieve
      description: Check if a database name is available.
      parameters:
      - in: query
        name: name
        schema:
          type: string
          minLength: 1
        description: Database name to check
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckDatabaseNameResponse'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/completed_activity/:
    get:
      operationId: data_warehouse_completed_activity_retrieve
      description: 'Returns completed/non-running activities (jobs with status ''Completed'').

        Supports pagination and cutoff time filtering.'
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/data_health_issues/:
    get:
      operationId: data_warehouse_data_health_issues_retrieve
      description: 'Returns failed/disabled data pipeline items for the Pipeline status side panel.

        Includes: materializations, syncs, sources, destinations, and transformations.'
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/data_ops_dashboard/:
    get:
      operationId: data_warehouse_data_ops_dashboard_retrieve
      description: Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/deprovision/:
    post:
      operationId: data_warehouse_deprovision_create
      description: Start deprovisioning the managed warehouse for this team.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeprovisionWarehouseResponse'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/job_stats/:
    get:
      operationId: data_warehouse_job_stats_retrieve
      description: '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).'
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/property_values/:
    get:
      operationId: data_warehouse_property_values_retrieve
      description: API endpoints for data warehouse aggregate statistics and operations.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - query:read
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/provision/:
    post:
      operationId: data_warehouse_provision_create
      description: Start provisioning a managed warehouse for this team.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProvisionWarehouseRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ProvisionWarehouseRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ProvisionWarehouseRequest'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisionWarehouseResponse'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/reset-password/:
    post:
      operationId: data_warehouse_reset_password_create
      description: Reset the root password for the managed warehouse.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetPasswordResponse'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/running_activity/:
    get:
      operationId: data_warehouse_running_activity_retrieve
      description: 'Returns currently running activities (jobs with status ''Running'').

        Supports pagination and cutoff time filtering.'
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/total_rows_stats/:
    get:
      operationId: data_warehouse_total_rows_stats_retrieve
      description: '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.'
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/data_warehouse/warehouse_status/:
    get:
      operationId: data_warehouse_warehouse_status_retrieve
      description: Get the current provisioning status of the managed warehouse.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WarehouseStatusResponse'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_schemas/:
    get:
      operationId: external_data_schemas_list
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - $ref: '#/components/parameters/ProjectIdPath'
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExternalDataSchemaList'
          description: ''
      x-explicit-tags:
      - data_warehouse
    post:
      operationId: external_data_schemas_create
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSchema'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_schemas/{id}/:
    get:
      operationId: external_data_schemas_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSchema'
          description: ''
      x-explicit-tags:
      - data_warehouse
    put:
      operationId: external_data_schemas_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSchema'
          description: ''
      x-explicit-tags:
      - data_warehouse
    patch:
      operationId: external_data_schemas_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSchema'
          description: ''
      x-explicit-tags:
      - data_warehouse
    delete:
      operationId: external_data_schemas_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '204':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_schemas/{id}/cancel/:
    post:
      operationId: external_data_schemas_cancel_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_schemas/{id}/delete_data/:
    delete:
      operationId: external_data_schemas_delete_data_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '204':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_schemas/{id}/incremental_fields/:
    post:
      operationId: external_data_schemas_incremental_fields_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_schemas/{id}/reload/:
    post:
      operationId: external_data_schemas_reload_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_schemas/{id}/resync/:
    post:
      operationId: external_data_schemas_resync_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data schema.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSchema'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/:
    get:
      operationId: external_data_sources_list
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - $ref: '#/components/parameters/ProjectIdPath'
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExternalDataSourceSerializersList'
          description: ''
      x-explicit-tags:
      - data_warehouse
    post:
      operationId: external_data_sources_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceCreate'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSourceSerializers'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/{id}/:
    get:
      operationId: external_data_sources_retrieve
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSourceSerializers'
          description: ''
      x-explicit-tags:
      - data_warehouse
    put:
      operationId: external_data_sources_update
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSourceSerializers'
          description: ''
      x-explicit-tags:
      - data_warehouse
    patch:
      operationId: external_data_sources_partial_update
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDataSourceSerializers'
          description: ''
      x-explicit-tags:
      - data_warehouse
    delete:
      operationId: external_data_sources_destroy
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '204':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/{id}/bulk_update_schemas/:
    patch:
      operationId: external_data_sources_bulk_update_schemas_partial_update
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - $ref: '#/components/parameters/ProjectIdPath'
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceBulkUpdateSchemas'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceBulkUpdateSchemas'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceBulkUpdateSchemas'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExternalDataSchemaList'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/{id}/create_webhook/:
    post:
      operationId: external_data_sources_create_webhook_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/{id}/delete_webhook/:
    post:
      operationId: external_data_sources_delete_webhook_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/{id}/jobs/:
    get:
      operationId: external_data_sources_jobs_retrieve
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/{id}/refresh_schemas/:
    post:
      operationId: external_data_sources_refresh_schemas_create
      description: Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync).
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/{id}/reload/:
    post:
      operationId: external_data_sources_reload_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/{id}/revenue_analytics_config/:
    patch:
      operationId: external_data_sources_revenue_analytics_config_partial_update
      description: Update the revenue analytics configuration and return the full external data source.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedExternalDataSourceSerializers'
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/{id}/update_webhook_inputs/:
    post:
      operationId: external_data_sources_update_webhook_inputs_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/{id}/webhook_info/:
    get:
      operationId: external_data_sources_webhook_info_retrieve
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this external data source.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/check_cdc_prerequisites/:
    post:
      operationId: external_data_sources_check_cdc_prerequisites_create
      description: '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 publications.'
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  valid:
                    type: boolean
                  errors:
                    type: array
                    items:
                      type: string
          description: Whether the Postgres database satisfies CDC prerequisites.
        '400':
          description: Invalid config, disallowed host, or connection failure.
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/connections/:
    get:
      operationId: external_data_sources_connections_list
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - $ref: '#/components/parameters/ProjectIdPath'
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExternalDataSourceConnectionOptionList'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/database_schema/:
    post:
      operationId: external_data_sources_database_schema_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatabaseSchemaRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DatabaseSchemaRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DatabaseSchemaRequest'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/source_prefix/:
    post:
      operationId: external_data_sources_source_prefix_create
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalDataSourceSerializers'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/external_data_sources/wizard/:
    get:
      operationId: external_data_sources_wizard_retrieve
      description: Create, Read, Update and Delete External data Sources.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - external_data_source:read
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/insight_variables/:
    get:
      operationId: insight_variables_list
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedInsightVariableList'
          description: ''
      x-explicit-tags:
      - data_warehouse
    post:
      operationId: insight_variables_create
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightVariable'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/InsightVariable'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/InsightVariable'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightVariable'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/insight_variables/{id}/:
    get:
      operationId: insight_variables_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this insight variable.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightVariable'
          description: ''
      x-explicit-tags:
      - data_warehouse
    put:
      operationId: insight_variables_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this insight variable.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightVariable'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/InsightVariable'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/InsightVariable'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightVariable'
          description: ''
      x-explicit-tags:
      - data_warehouse
    patch:
      operationId: insight_variables_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this insight variable.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedInsightVariable'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedInsightVariable'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedInsightVariable'
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightVariable'
          description: ''
      x-explicit-tags:
      - data_warehouse
    delete:
      operationId: insight_variables_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this insight variable.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - insight_variable:write
      responses:
        '204':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/:
    get:
      operationId: warehouse_saved_queries_list
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - $ref: '#/components/parameters/ProjectIdPath'
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDataWarehouseSavedQueryMinimalList'
          description: ''
      x-explicit-tags:
      - data_warehouse
    post:
      operationId: warehouse_saved_queries_create
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/{id}/:
    get:
      operationId: warehouse_saved_queries_retrieve
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
    put:
      operationId: warehouse_saved_queries_update
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
    patch:
      operationId: warehouse_saved_queries_partial_update
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQuery'
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
    delete:
      operationId: warehouse_saved_queries_destroy
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '204':
          description: No response body
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/{id}/activity/:
    get:
      operationId: warehouse_saved_queries_activity_retrieve
      description: Create, Read, Update and Delete Warehouse Tables.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - activity_log:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/{id}/ancestors/:
    post:
      operationId: warehouse_saved_queries_ancestors_create
      description: '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.'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/{id}/cancel/:
    post:
      operationId: warehouse_saved_queries_cancel_create
      description: Cancel a running saved query workflow.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/{id}/dependencies/:
    get:
      operationId: warehouse_saved_queries_dependencies_retrieve
      description: Return the count of immediate upstream and downstream dependencies for this saved query.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/{id}/descendants/:
    post:
      operationId: warehouse_saved_queries_descendants_create
      description: '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. points to only

        descendants further than a leaf), we return an empty list.'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/{id}/materialize/:
    post:
      operationId: warehouse_saved_queries_materialize_create
      description: Enable materialization for this saved query with a 24-hour sync frequency.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/{id}/revert_materialization/:
    post:
      operationId: warehouse_saved_queries_revert_materialization_create
      description: 'Undo materialization, revert back to the original view.

        (i.e. delete the materialized table and the schedule)'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/{id}/run/:
    post:
      operationId: warehouse_saved_queries_run_create
      description: Run this saved query.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/{id}/run_history/:
    get:
      operationId: warehouse_saved_queries_run_history_retrieve
      description: Return the recent run history (up to 5 most recent) for this materialized view.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_queries/resume_schedules/:
    post:
      operationId: warehouse_saved_queries_resume_schedules_create
      description: 'Resume paused materialization schedules for multiple matviews.


        Accepts a list of view IDs in the request body: {"view_ids": ["id1", "id2", ...]}

        This endpoint is idempotent - calling it on already running or non-existent schedules is safe.'
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQuery'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_query_folders/:
    get:
      operationId: warehouse_saved_query_folders_list
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          description: ''
      x-explicit-tags:
      - data_warehouse
    post:
      operationId: warehouse_saved_query_folders_create
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          description: ''
      x-explicit-tags:
      - data_warehouse
  /api/projects/{project_id}/warehouse_saved_query_folders/{id}/:
    get:
      operationId: warehouse_saved_query_folders_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query folder.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          description: ''
      x-explicit-tags:
      - data_warehouse
    patch:
      operationId: warehouse_saved_query_folders_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query folder.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQueryFolder'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQueryFolder'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDataWarehouseSavedQueryFolder'
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataWarehouseSavedQueryFolder'
          description: ''
      x-explicit-tags:
      - data_warehouse
    delete:
      operationId: warehouse_saved_query_folders_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this data warehouse saved query folder.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - data_warehouse
      security:
      - PersonalAPIKeyAuth:
        - warehouse_view:write
      responses:
        '204':
          description: No response body
      x-explicit-tags:
      - data_warehouse
components:
  schemas:
    DataWarehouseSavedQueryFolder:
      type: object
      description: Mixin for serializers to add user access control fields
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          description: Display name for the folder used to organize saved queries in the SQL editor sidebar.
          maxLength: 128
        created_at:
          type: string
          format: date-time
          readOnly: true
        created_by:
          allOf:
          - $ref: '#/components/schemas/UserBasic'
          readOnly: true
        view_count:
          type: integer
          readOnly: true
        user_access_level:
          type: string
          nullable: true
          readOnly: true
          description: The effective access level the user has for this object
      required:
      - created_at
      - created_by
      - id
      - name
      - user_access_level
      - view_count
    SyncFrequencyEnum:
      enum:
      - never
      - 1min
      - 5min
      - 15min
      - 30min
      - 1hour
      - 6hour
      - 12hour
      - 24hour
      - 7day
      - 30day
      type: string
      description: '* `never` - never

        * `1min` - 1min

        * `5min` - 5min

        * `15min` - 15min

        * `30min` - 30min

        * `1hour` - 1hour

        * `6hour` - 6hour

        * `12hour` - 12hour

        * `24hour` - 24hour

        * `7day` - 7day

        * `30day` - 30day'
    PatchedExternalDataSourceBulkUpdateSchemas:
      type: object
      properties:
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/ExternalDataSourceBulkUpdateSchema'
          description: Schema updates to apply in a single batch.
    ProvisionWarehouseResponse:
      type: object
      properties:
        status:
          type: string
        team:
          type: string
      required:
      - status
      - team
    RoleAtOrganizationEnum:
      enum:
      - engineering
      - data
      - product
      - founder
      - leadership
      - marketing
      - sales
      - other
      type: string
      description: '* `engineering` - Engineering

        * `data` - Data

        * `product` - Product Management

        * `founder` - Founder

        * `leadership` - Leadership

        * `marketing` - Marketing

        * `sales` - Sales / Success

        * `other` - Other'
    DataWarehouseSavedQueryMinimal:
      type: object
      description: Lightweight serializer for list views - excludes large query field to reduce memory usage.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        deleted:
          type: boolean
          readOnly: true
          nullable: true
        name:
          type: string
          readOnly: true
        created_by:
          allOf:
          - $ref: '#/components/schemas/UserBasic'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        sync_frequency:
          type: string
          nullable: true
          readOnly: true
        columns:
          type: array
          items:
            type: object
            additionalProperties: true
          readOnly: true
        status:
          readOnly: true
          nullable: true
          description: 'The status of when this SavedQuery last ran.


            * `Cancelled` - Cancelled

            * `Modified` - Modified

            * `Completed` - Completed

            * `Failed` - Failed

            * `Running` - Running'
          oneOf:
          - $ref: '#/components/schemas/SavedQueryStatusEnum'
          - $ref: '#/components/schemas/NullEnum'
        last_run_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        managed_viewset_kind:
          type: string
          nullable: true
          readOnly: true
        folder_id:
          type: string
          format: uuid
          readOnly: true
          nullable: true
        folder_name:
          type: string
          readOnly: true
          nullable: true
        latest_error:
          type: string
          readOnly: true
          nullable: true
        is_materialized:
          type: boolean
          readOnly: true
          nullable: true
        origin:
          readOnly: true
          nullable: true
          description: 'Where this SavedQuery is created.


            * `data_warehouse` - Data Warehouse

            * `endpoint` - Endpoint

            * `managed_viewset` - Managed Viewset'
          oneOf:
          - $ref: '#/components/schemas/OriginEnum'
          - $ref: '#/components/schemas/NullEnum'
        is_test:
          type: boolean
          readOnly: true
          description: Whether this view is for testing only and will auto-expire.
        expires_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          description: When this test view should be automatically deleted.
        user_access_level:
          type: string
          nullable: true
          readOnly: true
          description: The effective access level the user has for this object
      required:
      - columns
      - created_at
      - created_by
      - deleted
      - expires_at
      - folder_id
      - folder_name
      - id
      - is_materialized
      - is_test
      - last_run_at
      - latest_error
      - managed_viewset_kind
      - name
      - origin
      - status
      - sync_frequency
      - user_access_level
    ExternalDataSourceCreate:
      type: object
      properties:
        source_type:
          allOf:
          - $ref: '#/components/schemas/ExternalDataSourceTypeEnum'
          description: 'The source type (e.g. ''Postgres'', ''Stripe'').


            * `Ashby` - Ashby

            * `Supabase` - Supabase

            * `CustomerIO` - CustomerIO

            * `Github` - Github

            * `Stripe` - Stripe

            * `Hubspot` - Hubspot

            * `Postgres` - Postgres

            * `Zendesk` - Zendesk

            * `Snowflake` - Snowflake

            * `Salesforce` - Salesforce

            * `MySQL` - MySQL

            * `MongoDB` - MongoDB

            * `MSSQL` - MSSQL

            * `Vitally` - Vitally

            * `BigQuery` - BigQuery

            * `Chargebee` - Chargebee

            * `Clerk` - Clerk

            * `GoogleAds` - GoogleAds

            * `TemporalIO` - TemporalIO

            * `DoIt` - DoIt

            * `GoogleSheets` - GoogleSheets

            * `MetaAds` - MetaAds

            * `Klaviyo` - Klaviyo

            * `Mailchimp` - Mailchimp

            * `Braze` - Braze

            * `Mailjet` - Mailjet

            * `Redshift` - Redshift

            * `Polar` - Polar

            * `RevenueCat` - RevenueCat

            * `LinkedinAds` - LinkedinAds

            * `RedditAds` - RedditAds

            * `TikTokAds` - TikTokAds

            * `BingAds` - BingAds

            * `Shopify` - Shopify

            * `Attio` - Attio

            * `SnapchatAds` - SnapchatAds

            * `Linear` - Linear

            * `Intercom` - Intercom

            * `Amplitude` - Amplitude

            * `Mixpanel` - Mixpanel

            * `Jira` - Jira

            * `ActiveCampaign` - ActiveCampaign

            * `Marketo` - Marketo

            * `Adjust` - Adjust

            * `AppsFlyer` - AppsFlyer

            * `Freshdesk` - Freshdesk

            * `GoogleAnalytics` - GoogleAnalytics

            * `Pipedrive` - Pipedrive

            * `SendGrid` - SendGrid

            * `Slack` - Slack

            * `PagerDuty` - PagerDuty

            * `Asana` - Asana

            * `Notion` - Notion

            * `Airtable` - Airtable

            * `Greenhouse` - Greenhouse

            * `BambooHR` - BambooHR

            * `Lever` - Lever

            * `GitLab` - GitLab

            * `Datadog` - Datadog

            * `Sentry` - Sentry

            * `Pendo` - Pendo

            * `FullStory` - FullStory

            * `AmazonAds` - AmazonAds

            * `PinterestAds` - PinterestAds

            * `AppleSearchAds` - AppleSearchAds

            * `QuickBooks` - QuickBooks

            * `Xero` - Xero

            * `NetSuite` - NetSuite

            * `WooCommerce` - WooCommerce

            * `BigCommerce` - BigCommerce

            * `PayPal` - PayPal

            * `Square` - Square

            * `Zoom` - Zoom

            * `Trello` - Trello

            * `Monday` - Monday

            * `ClickUp` - ClickUp

            * `Confluence` - Confluence

            * `Recurly` - Recurly

            * `SalesLoft` - SalesLoft

            * `Outreach` - Outreach

            * `Gong` - Gong

            * `Calendly` - Calendly

            * `Typeform` - Typeform

            * `Iterable` - Iterable

            * `ZohoCRM` - ZohoCRM

            * `Close` - Close

            * `Oracle` - Oracle

            * `DynamoDB` - DynamoDB

            * `Elasticsearch` - Elasticsearch

            * `Kafka` - Kafka

            * `LaunchDarkly` - LaunchDarkly

            * `Braintree` - Braintree

            * `Recharge` - Recharge

            * `HelpScout` - HelpScout

            * `Gorgias` - Gorgias

            * `Instagram` - Instagram

            * `YouTubeAnalytics` - YouTubeAnalytics

            * `FacebookPages` - FacebookPages

            * `TwitterAds` - TwitterAds

            * `Workday` - Workday

            * `ServiceNow` - ServiceNow

            * `Pardot` - Pardot

            * `Copper` - Copper

            * `Front` - Front

            * `ChartMogul` - ChartMogul

            * `Zuora` - Zuora

            * `Paddle` - Paddle

            * `CircleCI` - CircleCI

            * `CockroachDB` - CockroachDB

            * `Firebase` - Firebase

            * `AzureBlob` - AzureBlob

            * `GoogleDrive` - GoogleDrive

            * `OneDrive` - OneDrive

            * `SharePoint` - SharePoint

            * `Box` - Box

            * `SFTP` - SFTP

            * `MicrosoftTeams` - MicrosoftTeams

            * `Aircall` - Aircall

            * `Webflow` - Webflow

            * `Okta` - Okta

            * `Auth0` - Auth0

            * `Productboard` - Productboard

            * `Smartsheet` - Smartsheet

            * `Wrike` - Wrike

            * `Plaid` - Plaid

            * `SurveyMonkey` - SurveyMonkey

            * `Eventbrite` - Eventbrite

            * `RingCentral` - RingCentral

            * `Twilio` - Twilio

            * `Freshsales` - Freshsales

            * `Shortcut` - Shortcut

            * `ConvertKit` - ConvertKit

            * `Drip` - Drip

            * `CampaignMonitor` - CampaignMonitor

            * `MailerLite` - MailerLite

            * `Omnisend` - Omnisend

            * `Brevo` - Brevo

            * `Postmark` - Postmark

            * `Granola` - Granola

            * `BuildBetter` - BuildBetter

            * `Convex` - Convex

            * `ClickHouse` - ClickHouse

            * `Plain` - Plain

            * `Resend` - Resend'
        payload:
          type: object
          additionalProperties: true
          description: Connection credentials and a 'schemas' array. Keys depend on source_type.
        prefix:
          type: string
          nullable: true
          description: Table name prefix in HogQL.
          maxLength: 100
        description:
          type: string
          nullable: true
          description: Human-readable description.
          maxLength: 400
        access_method:
          allOf:
          - $ref: '#/components/schemas/AccessMethodEnum'
          default: warehouse
          description: 'Connection mode: ''warehouse'' (import) or ''direct'' (live query).


            * `warehouse` - warehouse

            * `direct` - direct'
        created_via:
          allOf:
          - $ref: '#/components/schemas/CreatedViaEnum'
          default: api
          description: 'Where the request came from


            * `web` - web

            * `api` - api

            * `mcp` - mcp'
      required:
      - payload
      - source_type
    PaginatedDataModelingJobList:
      type: object
      required:
      - results
      properties:
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?cursor=cD00ODY%3D"
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?cursor=cj0xJnA9NDg3
        results:
          type: array
          items:
            $ref: '#/components/schemas/DataModelingJob'
    NullEnum:
      enum:
      - null
    ProvisionWarehouseRequest:
      type: object
      properties:
        database_name:
          type: string
          description: Name for the new database
      required:
      - database_name
    PatchedExternalDataSchema:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          readOnly: true
        label:
          type: string
          readOnly: true
          nullable: true
        table:
          type: object
          additionalProperties: true
          nullable: true
          readOnly: true
        should_sync:
          type: boolean
        last_synced_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        latest_error:
          type: string
          readOnly: true
          nullable: true
          description: The latest error that occurred when syncing this schema.
        incremental:
          type: boolean
          readOnly: true
        status:
          type: string
          nullable: true
          readOnly: true
        sync_type:
          nullable: true
          description: 'Sync strategy: incremental, full_refresh, append, or cdc.


            * `full_refresh` - full_refresh

            * `incremental` - incremental

            * `append` - append

            * `webhook` - webhook

            * `cdc` - cdc'
          oneOf:
          - $ref: '#/components/schemas/SyncTypeEnum'
          - $ref: '#/components/schemas/NullEnum'
        incremental_field:
          type: string
          nullable: true
          description: Column name used to track sync progress.
        incremental_field_type:
          nullable: true
          description: 'Data type of the incremental field.


            * `integer` - integer

            * `numeric` - numeric

            * `datetime` - datetime

            * `date` - date

            * `timestamp` - timestamp

            * `objectid` - objectid'
          oneOf:
          - $ref: '#/components/schemas/IncrementalFieldTypeEnum'
          - $ref: '#/components/schemas/NullEnum'
        sync_frequency:
          nullable: true
          description: 'How often to sync.


            * `never` - never

            * `1min` - 1min

            * `5min` - 5min

            * `15min` - 15min

            * `30min` - 30min

            * `1hour` - 1hour

            * `6hour` - 6hour

            * `12hour` - 12hour

            * `24hour` - 24hour

            * `7day` - 7day

            * `30day` - 30day'
          oneOf:
          - $ref: '#/components/schemas/SyncFrequencyEnum'
          - $ref: '#/components/schemas/NullEnum'
        sync_time_of_day:
          type: string
          format: time
          nullable: true
          description: UTC time of day to run the sync (HH:MM:SS).
        description:
          type: string
          readOnly: true
          nullable: true
        primary_key_columns:
          type: array
          items:
            type: string
          nullable: true
          description: Column names for primary key deduplication.
        cdc_table_mode:
          nullable: true
          description: 'For CDC syncs: consolidated, cdc_only, or both.


            * `consolidated` - consolidated

            * `cdc_only` - cdc_only

            * `both` - both'
          oneOf:
          - $ref: '#/components/schemas/CdcTableModeEnum'
          - $ref: '#/components/schemas/NullEnum'
    ExternalDataSourceRevenueAnalyticsConfig:
      type: object
      properties:
        enabled:
          type: boolean
        include_invoiceless_charges:
          type: boolean
    CreatedViaEnum:
      enum:
      - web
      - api
      - mcp
      type: string
      description: '* `web` - web

        * `api` - api

        * `mcp` - mcp'
    UserBasic:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        uuid:
          type: string
          format: uuid
          readOnly: true
        distinct_id:
          type: string
          nullable: true
          maxLength: 200
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
        email:
          type: string
          format: email
          title: Email address
          maxLength: 254
        is_email_verified:
          type: boolean
          nullable: true
        hedgehog_config:
          type: object
          additionalProperties: true
          nullable: true
          readOnly: true
        role_at_organization:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/RoleAtOrganizationEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
      required:
      - email
      - hedgehog_config
      - id
      - uuid
    ResetPasswordResponse:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
      required:
      - password
      - username
    PaginatedDataWarehouseSavedQueryMinimalList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/DataWarehouseSavedQueryMinimal'
    IncrementalFieldTypeEnum:
      enum:
      - integer
      - numeric
      - datetime
      - date
      - timestamp
      - objectid
      type: string
      description: '* `integer` - integer

        * `numeric` - numeric

        * `datetime` - datetime

        * `date` - date

        * `timestamp` - timestamp

        * `objectid` - objectid'
    EngineEnum:
      enum:
      - duckdb
      - postgres
      type: string
      description: '* `duckdb` - duckdb

        * `postgres` - postgres'
    PaginatedExternalDataSchemaList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/ExternalDataSchema'
    PaginatedExternalDataSourceSerializersList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/ExternalDataSourceSerializers'
    PaginatedExternalDataSourceConnectionOptionList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/ExternalDataSourceConnectionOption'
    ExternalDataSourceTypeEnum:
      enum:
      - Ashby
      - Supabase
      - CustomerIO
      - Github
      - Stripe
      - Hubspot
      - Postgres
      - Zendesk
      - Snowflake
      - Salesforce
      - MySQL
      - MongoDB
      - MSSQL
      - Vitally
      - BigQuery
      - Chargebee
      - Clerk
      - GoogleAds
      - TemporalIO
      - DoIt
      - GoogleSheets
      - MetaAds
      - Klaviyo
      - Mailchimp
      - Braze
      - Mailjet
      - Redshift
      - Polar
      - RevenueCat
      - LinkedinAds
      - RedditAds
      - TikTokAds
      - BingAds
      - Shopify
      - Attio
      - SnapchatAds
      - Linear
      - Intercom
      - Amplitude
      - Mixpanel
      - Jira
      - ActiveCampaign
      - Marketo
      - Adjust
      - AppsFlyer
      - Freshdesk
      - GoogleAnalytics
      - Pipedrive
      - SendGrid
      - Slack
      - PagerDuty
      - Asana
      - Notion
      - Airtable
      - Greenhouse
      - BambooHR
      - Lever
      - GitLab
      - Datadog
      - Sentry
      - Pendo
      - FullStory
      - AmazonAds
      - PinterestAds
      - AppleSearchAds
      - QuickBooks
      - Xero
      - NetSuite
      - WooCommerce
      - BigCommerce
      - PayPal
      - Square
      - Zoom
      - Trello
      - Monday
      - ClickUp
      - Confluence
      - Recurly
      - SalesLoft
      - Outreach
      - Gong
      - Calendly
      - Typeform
      - Iterable
      - ZohoCRM
      - Close
      - Oracle
      - DynamoDB
      - Elasticsearch
      - Kafka
      - LaunchDarkly
      - Braintree
      - Recharge
      - HelpScout
      - Gorgias
      - Instagram
      - YouTubeAnalytics
      - FacebookPages
      - TwitterAds
      - Workday
      - ServiceNow
      - Pardot
      - Copper
      - Front
      - ChartMogul
      - Zuora
      - Paddle
      - CircleCI
      - CockroachDB
      - Firebase
      - AzureBlob
      - GoogleDrive
      - OneDrive
      - SharePoint
      - Box
      - SFTP
      - MicrosoftTeams
      - Aircall
      - Webflow
      - Okta
      - Auth0
      - Productboard
      - Smartsheet
      - Wrike
      - Plaid
      - SurveyMonkey
      - Eventbrite
      - RingCentral
      - Twilio
      - Freshsales
      - Shortcut
      - ConvertKit
      - Drip
      - CampaignMonitor
      - MailerLite
      - Omnisend
      - Brevo
      - Postmark
      - Granola
      - BuildBetter
      - Convex
      - ClickHouse
      - Plain
      - Resend
      type: string
      description: '* `Ashby` - Ashby

        * `Supabase` - Supabase

        * `CustomerIO` - CustomerIO

        * `Github` - Github

        * `Stripe` - Stripe

        * `Hubspot` - Hubspot

        * `Postgres` - Postgres

        * `Zendesk` - Zendesk

        * `Snowflake` - Snowflake

        * `Salesforce` - Salesforce

        * `MySQL` - MySQL

        * `MongoDB` - MongoDB

        * `MSSQL` - MSSQL

        * `Vitally` - Vitally

        * `BigQuery` - BigQuery

        * `Chargebee` - Chargebee

        * `Clerk` - Clerk

        * `GoogleAds` - GoogleAds

        * `TemporalIO` - TemporalIO

        * `DoIt` - DoIt

        * `GoogleSheets` - GoogleSheets

        * `MetaAds` - MetaAds

        * `Klaviyo` - Klaviyo

        * `Mailchimp` - Mailchimp

        * `Braze` - Braze

        * `Mailjet` - Mailjet

        * `Redshift` - Redshift

        * `Polar` - Polar

        * `RevenueCat` - RevenueCat

        * `LinkedinAds` - LinkedinAds

        * `RedditAds` - RedditAds

        * `TikTokAds` - TikTokAds

        * `BingAds` - BingAds

        * `Shopify` - Shopify

        * `Attio` - Attio

        * `SnapchatAds` - SnapchatAds

        * `Linear` - Linear

        * `Intercom` - Intercom

        * `Amplitude` - Amplitude

        * `Mixpanel` - Mixpanel

        * `Jira` - Jira

        * `ActiveCampaign` - ActiveCampaign

        * `Marketo` - Marketo

        * `Adjust` - Adjust

        * `AppsFlyer` - AppsFlyer

        * `Freshdesk` - Freshdesk

        * `GoogleAnalytics` - GoogleAnalytics

        * `Pipedrive` - Pipedrive

        * `SendGrid` - SendGrid

        * `Slack` - Slack

        * `PagerDuty` - PagerDuty

        * `Asana` - Asana

        * `Notion` - Notion

        * `Airtable` - Airtable

        * `Greenhouse` - Greenhouse

        * `BambooHR` - BambooHR

        * `Lever` - Lever

        * `GitLab` - GitLab

        * `Datadog` - Datadog

        * `Sentry` - Sentry

        * `Pendo` - Pendo

        * `FullStory` - FullStory

        * `AmazonAds` - AmazonAds

        * `PinterestAds` - PinterestAds

        * `AppleSearchAds` - AppleSearchAds

        * `QuickBooks` - QuickBooks

        * `Xero` - Xero

        * `NetSuite` - NetSuite

        * `WooCommerce` - WooCommerce

        * `BigCommerce` - BigCommerce

        * `PayPal` - PayPal

        * `Square` - Square

        * `Zoom` - Zoom

        * `Trello` - Trello

        * `Monday` - Monday

        * `ClickUp` - ClickUp

        * `Confluence` - Confluence

        * `Recurly` - Recurly

        * `SalesLoft` - SalesLoft

        * `Outreach` - Outreach

        * `Gong` - Gong

        * `Calendly` - Calendly

        * `Typeform` - Typeform

        * `Iterable` - Iterable

        * `ZohoCRM` - ZohoCRM

        * `Close` - Close

        * `Oracle` - Oracle

        * `DynamoDB` - DynamoDB

        * `Elasticsearch` - Elasticsearch

        * `Kafka` - Kafka

        * `LaunchDarkly` - LaunchDarkly

        * `Braintree` - Braintree

        * `Recharge` - Recharge

        * `HelpScout` - HelpScout

        * `Gorgias` - Gorgias

        * `Instagram` - Instagram

        * `YouTubeAnalytics` - YouTubeAnalytics

        * `FacebookPages` - FacebookPages

        * `TwitterAds` - TwitterAds

        * `Workday` - Workday

        * `ServiceNow` - ServiceNow

        * `Pardot` - Pardot

        * `Copper` - Copper

        * `Front` - Front

        * `ChartMogul` - ChartMogul

        * `Zuora` - Zuora

        * `Paddle` - Paddle

        * `CircleCI` - CircleCI

        * `CockroachDB` - CockroachDB

        * `Firebase` - Firebase

        * `AzureBlob` - AzureBlob

        * `GoogleDrive` - GoogleDrive

        * `OneDrive` - OneDrive

        * `SharePoint` - SharePoint

        * `Box` - Box

        * `SFTP` - SFTP

        * `MicrosoftTeams` - MicrosoftTeams

        * `Aircall` - Aircall

        * `Webflow` - Webflow

        * `Okta` - Okta

        * `Auth0` - Auth0

        * `Productboard` - Productboard

        * `Smartsheet` - Smartsheet

        * `Wrike` - Wrike

        * `Plaid` - Plaid

        * `SurveyMonkey` - SurveyMonkey

        * `Eventbrite` - Eventbrite

        * `RingCentral` - RingCentral

        * `Twilio` - Twilio

        * `Freshsales` - Freshsales

        * `Shortcut` - Shortcut

        * `ConvertKit` - ConvertKit

        * `Drip` - Drip

        * `CampaignMonitor` - CampaignMonitor

        * `MailerLite` - MailerLite

        * `Omnisend` - Omnisend

        * `Brevo` - Brevo

        * `Postmark` - Postmark

        * `Granola` - Granola

        * `BuildBetter` - BuildBetter

        * `Convex` - Convex

        * `ClickHouse` - ClickHouse

        * `Plain` - Plain

        * `Resend` - Resend'
    WarehouseStatusResponse:
      type: object
      properties:
        team_name:
          type: string
        state:
          $ref: '#/components/schemas/WarehouseStatusResponseStateEnum'
        status_message:
          type: string
        ready_at:
          type: string
          format: date-time
          nullable: true
        failed_at:
          type: string
          format: date-time
          nullable: true
      required:
      - failed_at
      - ready_at
      - state
      - status_message
      - team_name
    ExternalDataSourceBulkUpdateSchema:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Schema identifier to update.
        should_sync:
          type: boolean
          description: Whether the schema should be queryable/synced.
        sync_type:
          nullable: true
          description: 'Requested sync mode for the schema.


            * `full_refresh` - full_refresh

            * `incremental` - incremental

            * `append` - append

            * `webhook` - webhook

            * `cdc` - cdc'
          oneOf:
          - $ref: '#/components/schemas/SyncTypeEnum'
          - $ref: '#/components/schemas/NullEnum'
        incremental_field:
          type: string
          nullable: true
          description: Incremental cursor field for incremental or append syncs.
        incremental_field_type:
          type: string
          nullable: true
          description: Type of the incremental cursor field.
        sync_frequency:
          type: string
          nullable: true
          description: Human-readable sync frequency value.
        sync_time_of_day:
          type: string
          format: time
          nullable: true
          description: UTC anchor time for scheduled syncs.
        cdc_table_mode:
          nullable: true
          description: 'How CDC-backed tables should be exposed.


            * `consolidated` - consolidated

            * `cdc_only` - cdc_only

            * `both` - both'
          oneOf:
          - $ref: '#/components/schemas/CdcTableModeEnum'
          - $ref: '#/components/schemas/NullEnum'
      required:
      - id
    CheckDatabaseNameResponse:
      type: object
      properties:
        name:
          type: string
        available:
          type: boolean
      required:
      - available
      - name
    DeprovisionWarehouseResponse:
      type: object
      properties:
        status:
          type: string
        team:
          type: string
      required:
      - status
      - team
    SavedQueryStatusEnum:
      enum:
      - Cancelled
      - Modified
      - Completed
      - Failed
      - Running
      type: string
      description: '* `Cancelled` - Cancelled

        * `Modified` - Modified

        * `Completed` - Completed

        * `Failed` - Failed

        * `Running` - Running'
    DataModelingJobStatusEnum:
      enum:
      - Cancelled
      - Completed
      - Failed
      - Running
      type: string
      description: '* `Cancelled` - Cancelled

        * `Completed` - Completed

        * `Failed` - Failed

        * `Running` - Running'
    InsightVariable:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: UUID of the SQL variable.
        name:
          type: string
          description: Human-readable name for the SQL variable.
          maxLength: 400
        type:
          allOf:
          - $ref: '#/components/schemas/InsightVariableTypeEnum'
          description: 'Variable type. Controls how the value is rendered and substituted in HogQL.


            * `String` - String

            * `Number` - Number

            * `Boolean` - Boolean

            * `List` - List

            * `Date` - Date'
        default_value:
          nullable: true
          description: Default value used when a query references this variable.
        created_by:
          type: integer
          readOnly: true
          nullable: true
          description: ID of the user who created the SQL variable.
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: Timestamp when the SQL variable was created.
        code_name:
          type: string
          readOnly: true
          nullable: true
          description: Generated code-safe name used in HogQL as {variables.code_name}. Derived from name.
        values:
          nullable: true
          description: Allowed values for List variables. Null for other variable types.
      required:
      - code_name
      - created_at
      - created_by
      - id
      - name
      - type
    PatchedDataWarehouseSavedQueryFolder:
      type: object
      description: Mixin for serializers to add user access control fields
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          description: Display name for the folder used to organize saved queries in the SQL editor sidebar.
          maxLength: 128
        created_at:
          type: string
          format: date-time
          readOnly: true
        created_by:
          allOf:
          - $ref: '#/components/schemas/UserBasic'
          readOnly: true
        view_count:
          type: integer
          readOnly: true
        user_access_level:
          type: string
          nullable: true
          readOnly: true
          description: The effective access level the user has for this object
    DatabaseSchemaRequest:
      type: object
      description: 'Validate credentials and preview available tables from a remote database.


        The request body contains source_type plus flat source-specific credential fields

        (e.g. host, port, database, user, password, schema for Postgres). The credential

        fields vary per source_type and are validated dynamically by the source registry.'
      properties:
        source_type:
          allOf:
          - $ref: '#/components/schemas/ExternalDataSourceTypeEnum'
          description: 'The source type to validate against.


            * `Ashby` - Ashby

            * `Supabase` - Supabase

            * `CustomerIO` - CustomerIO

            * `Github` - Github

            * `Stripe` - Stripe

            * `Hubspot` - Hubspot

            * `Postgres` - Postgres

            * `Zendesk` - Zendesk

            * `Snowflake` - Snowflake

            * `Salesforce` - Salesforce

            * `MySQL` - MySQL

            * `MongoDB` - MongoDB

            * `MSSQL` - MSSQL

            * `Vitally` - Vitally

            * `BigQuery` - BigQuery

            * `Chargebee` - Chargebee

            * `Clerk` - Clerk

            * `GoogleAds` - GoogleAds

            * `TemporalIO` - TemporalIO

            * `DoIt` - DoIt

            * `GoogleSheets` - GoogleSheets

            * `MetaAds` - MetaAds

            * `Klaviyo` - Klaviyo

            * `Mailchimp` - Mailchimp

            * `Braze` - Braze

            * `Mailjet` - Mailjet

            * `Redshift` - Redshift

            * `Polar` - Polar

            * `RevenueCat` - RevenueCat

            * `LinkedinAds` - LinkedinAds

            * `RedditAds` - RedditAds

            * `TikTokAds` - TikTokAds

            * `BingAds` - BingAds

            * `Shopify` - Shopify

            * `Attio` - Attio

            * `SnapchatAds` - SnapchatAds

            * `Linear` - Linear

            * `Intercom` - Intercom

            * `Amplitude` - Amplitude

            * `Mixpanel` - Mixpanel

            * `Jira` - Jira

            * `ActiveCampaign` - ActiveCampaign

            * `Marketo` - Marketo

            * `Adjust` - Adjust

            * `AppsFlyer` - AppsFlyer

            * `Freshdesk` - Freshdesk

            * `GoogleAnalytics` - GoogleAnalytics

            * `Pipedrive` - Pipedrive

            * `SendGrid` - SendGrid

            * `Slack` - Slack

            * `PagerDuty` - PagerDuty

            * `Asana` - Asana

            * `Notion` - Notion

            * `Airtable` - Airtable

            * `Greenhouse` - Greenhouse

            * `BambooHR` - BambooHR

            * `Lever` - Lever

            * `GitLab` - GitLab

            * `Datadog` - Datadog

            * `Sentry` - Sentry

            * `Pendo` - Pendo

            * `FullStory` - FullStory

            * `AmazonAds` - AmazonAds

            * `PinterestAds` - PinterestAds

            * `AppleSearchAds` - AppleSearchAds

            * `QuickBooks` - QuickBooks

            * `Xero` - Xero

            * `NetSuite` - NetSuite

            * `WooCommerce` - WooCommerce

            * `BigCommerce` - BigCommerce

            * `PayPal` - PayPal

            * `Square` - Square

            * `Zoom` - Zoom

            * `Trello` - Trello

            * `Monday` - Monday

            * `ClickUp` - ClickUp

            * `Confluence` - Confluence

            * `Recurly` - Recurly

            * `SalesLoft` - SalesLoft

            * `Outreach` - Outreach

            * `Gong` - Gong

            * `Calendly` - Calendly

            * `Typeform` - Typeform

            * `Iterable` - Iterable

            * `ZohoCRM` - ZohoCRM

            * `Close` - Close

            * `Oracle` - Oracle

            * `DynamoDB` - DynamoDB

            * `Elasticsearch` - Elasticsearch

            * `Kafka` - Kafka

            * `LaunchDarkly` - LaunchDarkly

            * `Braintree` - Braintree

            * `Recharge` - Recharge

            * `HelpScout` - HelpScout

            * `Gorgias` - Gorgias

            * `Instagram` - Instagram

            * `YouTubeAnalytics` - YouTubeAnalytics

            * `FacebookPages` - FacebookPages

            * `TwitterAds` - TwitterAds

            * `Workday` - Workday

            * `ServiceNow` - ServiceNow

            * `Pardot` - Pardot

            * `Copper` - Copper

            * `Front` - Front

            * `ChartMogul` - ChartMogul

            * `Zuora` - Zuora

            * `Paddle` - Paddle

            * `CircleCI` - CircleCI

            * `CockroachDB` - CockroachDB

            * `Firebase` - Firebase

            * `AzureBlob` - AzureBlob

            * `GoogleDrive` - GoogleDrive

            * `OneDrive` - OneDrive

            * `SharePoint` - SharePoint

            * `Box` - Box

            * `SFTP` - SFTP

            * `MicrosoftTeams` - MicrosoftTeams

            * `Aircall` - Aircall

            * `Webflow` - Webflow

            * `Okta` - Okta

            * `Auth0` - Auth0

            * `Productboard` - Productboard

            * `Smartsheet` - Smartsheet

            * `Wrike` - Wrike

            * `Plaid` - Plaid

            * `SurveyMonkey` - SurveyMonkey

            * `Eventbrite` - Eventbrite

            * `RingCentral` - RingCentral

            * `Twilio` - Twilio

            * `Freshsales` - Freshsales

            * `Shortcut` - Shortcut

            * `ConvertKit` - ConvertKit

            * `Drip` - Drip

            * `CampaignMonitor` - CampaignMonitor

            * `MailerLite` - MailerLite

            * `Omnisend` - Omnisend

            * `Brevo` - Brevo

            * `Postmark` - Postmark

            * `Granola` - Granola

            * `BuildBetter` - BuildBetter

            * `Convex` - Convex

            * `ClickHouse` - ClickHouse

            * `Plain` - Plain

            * `Resend` - Resend'
      required:
      - source_type
    PaginatedInsightVariableList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/InsightVariable'
    InsightVariableTypeEnum:
      enum:
      - String
      - Number
      - Boolean
      - List
      - Date
      type: string
      description: '* `String` - String

        * `Number` - Number

        * `Boolean` - Boolean

        * `List` - List

        * `Date` - Date'
    WarehouseStatusResponseStateEnum:
      enum:
      - pending
      - provisioning
      - ready
      - failed
      - deleting
      - deleted
      type: string
      description: '* `pending` - pending

        * `provisioning` - provisioning

        * `ready` - ready

        * `failed` - failed

        * `deleting` - deleting

        * `deleted` - deleted'
    ExternalDataSchema:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          readOnly: true
        label:
          type: string
          readOnly: true
          nullable: true
        table:
          type: object
          additionalProperties: true
          nullable: true
          readOnly: true
        should_sync:
          type: boolean
        last_synced_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        latest_error:
          type: string
          readOnly: true
          nullable: true
          description: The latest error that occurred when syncing this schema.
        incremental:
          type: boolean
          readOnly: true
        status:
          type: string
          nullable: true
          readOnly: true
        sync_type:
          nullable: true
          description: 'Sync strategy: incremental, full_refresh, append, or cdc.


            * `full_refresh` - full_refresh

            * `incremental` - incremental

            * `append` - append

            * `webhook` - webhook

            * `cdc` - cdc'
          oneOf:
          - $ref: '#/components/schemas/SyncTypeEnum'
          - $ref: '#/components/schemas/NullEnum'
        incremental_field:
          type: string
          nullable: true
          description: Column name used to track sync progress.
        incremental_field_type:
          nullable: true
          description: 'Data type of the incremental field.


            * `integer` - integer

            * `numeric` - numeric

            * `datetime` - datetime

            * `date` - date

            * `timestamp` - timestamp

            * `objectid` - objectid'
          oneOf:
          - $ref: '#/components/schemas/IncrementalFieldTypeEnum'
          - $ref: '#/components/schemas/NullEnum'
        sync_frequency:
          nullable: true
          description: 'How often to sync.


            * `never` - never

            * `1min` - 1min

            * `5min` - 5min

            * `15min` - 15min

            * `30min` - 30min

            * `1hour` - 1hour

            * `6hour` - 6hour

            * `12hour` - 12hour

            * `24hour` - 24hour

            * `7day` - 7day

            * `30day` - 30day'
          oneOf:
          - $ref: '#/components/schemas/SyncFrequencyEnum'
          - $ref: '#/components/schemas/NullEnum'
        sync_time_of_day:
          type: string
          format: time
          nullable: true
          description: UTC time of day to run the sync (HH:MM:SS).
        description:
          type: string
          readOnly: true
          nullable: true
        primary_key_columns:
          type: array
          items:
            type: string
          nullable: true
          description: Column names for primary key deduplication.
        cdc_table_mode:
          nullable: true
          description: 'For CDC syncs: consolidated, cdc_only, or both.


            * `consolidated` - consolidated

            * `cdc_only` - cdc_only

            * `both` - both'
          oneOf:
          - $ref: '#/components/schemas/CdcTableModeEnum'
          - $ref: '#/components/schemas/NullEnum'
      required:
      - description
      - id
      - incremental
      - label
      - last_synced_at
      - latest_error
      - name
      - status
      - table
    DataModelingJob:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        saved_query_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        status:
          allOf:
          - $ref: '#/components/schemas/DataModelingJobStatusEnum'
          readOnly: true
        rows_materialized:
          type: integer
          readOnly: true
        error:
          type: string
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        last_run_at:
          type: string
          format: date-time
          readOnly: true
        workflow_id:
          type: string
          readOnly: true
          nullable: true
        workflow_run_id:
          type: string
          readOnly: true
          nullable: true
        rows_expected:
          type: integer
          readOnly: true
          nullable: true
          description: Total rows expected to be materialized
      required:
      - created_at
      - error
      - id
      - last_run_at
      - rows_expected
      - rows_materialized
      - saved_query_id
      - status
      - workflow_id
      - workflow_run_id
    OriginEnum:
      enum:
      - data_warehouse
      - endpoint
      - managed_viewset
      type: string
      description: '* `data_warehouse` - Data Warehouse

        * `endpoint` - Endpoint

        * `managed_viewset` - Managed Viewset'
    PatchedDataWarehouseSavedQuery:
      type: object
      description: 'Shared methods for DataWarehouseSavedQuery serializers.


        This mixin is intended to be used with serializers.ModelSerializer subclasses.'
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        deleted:
          type: boolean
          nullable: true
        name:
          type: string
          description: Unique name for the view. Used as the table name in HogQL queries and the node name in the data modeling Node.
          maxLength: 128
        query:
          nullable: true
          description: 'HogQL query definition as a JSON object with a "query" key containing the SQL string and a "kind" key containing the query type. Example: {"query": "SELECT * FROM events LIMIT 100", "kind": "HogQLQuery"}'
        created_by:
          allOf:
          - $ref: '#/components/schemas/UserBasic'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        sync_frequency:
          type: string
          nullable: true
          readOnly: true
        columns:
          type: array
          items:
            type: object
            additionalProperties: true
          readOnly: true
        status:
          readOnly: true
          nullable: true
          description: 'The status of when this SavedQuery last ran.


            * `Cancelled` - Cancelled

            * `Modified` - Modified

            * `Completed` - Completed

            * `Failed` - Failed

            * `Running` - Running'
          oneOf:
          - $ref: '#/components/schemas/SavedQueryStatusEnum'
          - $ref: '#/components/schemas/NullEnum'
        last_run_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        managed_viewset_kind:
          type: string
          nullable: true
          readOnly: true
        folder_id:
          type: string
          format: uuid
          nullable: true
          description: Optional folder ID used to organize this view in the SQL editor sidebar.
        folder_name:
          type: string
          readOnly: true
          nullable: true
          description: Folder name used to organize this view in the SQL editor sidebar.
        latest_error:
          type: string
          readOnly: true
          nullable: true
        edited_history_id:
          type: string
          writeOnly: true
          nullable: true
          description: Activity log ID from the last known edit. Used for conflict detection.
        latest_history_id:
          type: integer
          nullable: true
          readOnly: true
        soft_update:
          type: boolean
          writeOnly: true
          nullable: true
          description: If true, skip column inference and validation. For saving drafts.
        dag_id:
          type: string
          format: uuid
          writeOnly: true
          nullable: true
          description: Optional DAG to place this view into
        is_materialized:
          type: boolean
          readOnly: true
          nullable: true
        origin:
          readOnly: true
          nullable: true
          description: 'Where this SavedQuery is created.


            * `data_warehouse` - Data Warehouse

            * `endpoint` - Endpoint

            * `managed_viewset` - Managed Viewset'
          oneOf:
          - $ref: '#/components/schemas/OriginEnum'
          - $ref: '#/components/schemas/NullEnum'
        is_test:
          type: boolean
          description: Whether this view is for testing only and will auto-expire.
        expires_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          description: When this test view should be automatically deleted.
        user_access_level:
          type: string
          nullable: true
          readOnly: true
          description: The effective access level the user has for this object
    CdcTableModeEnum:
      enum:
      - consolidated
      - cdc_only
      - both
      type: string
      description: '* `consolidated` - consolidated

        * `cdc_only` - cdc_only

        * `both` - both'
    ExternalDataSourceSerializers:
      type: object
      description: Mixin for serializers to add user access control fields
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        created_by:
          type: string
          nullable: true
          readOnly: true
        created_via:
          allOf:
          - $ref: '#/components/schemas/CreatedViaEnum'
          description: 'How this source was created. Defaults to `api` on create when omitted. `web` for the in-app UI, `api` for direct API callers, `mcp` for agent/MCP tool calls. Ignored on update.


            * `web` - web

            * `api` - api

            * `mcp` - mcp'
        status:
          type: string
          readOnly: true
        client_secret:
          type: string
          writeOnly: true
        account_id:
          type: string
          writeOnly: true
        source_type:
          allOf:
          - $ref: '#/components/schemas/ExternalDataSourceTypeEnum'
          readOnly: true
        latest_error:
          type: string
          nullable: true
          readOnly: true
        prefix:
          type: string
          nullable: true
          maxLength: 100
        description:
          type: string
          nullable: true
          maxLength: 400
        access_method:
          allOf:
          - $ref: '#/components/schemas/AccessMethodEnum'
          readOnly: true
        engine:
          readOnly: true
          nullable: true
          description: 'Backend engine detected for the direct connection.


            * `duckdb` - duckdb

            * `postgres` - postgres'
          oneOf:
          - $ref: '#/components/schemas/EngineEnum'
          - $ref: '#/components/schemas/NullEnum'
        last_run_at:
          type: string
          nullable: true
          readOnly: true
        schemas:
          type: array
          items:
            type: object
            additionalProperties: true
          readOnly: true
        job_inputs:
          nullable: true
        revenue_analytics_config:
          allOf:
          - $ref: '#/components/schemas/ExternalDataSourceRevenueAnalyticsConfig'
          readOnly: true
        user_access_level:
          type: string
          nullable: true
          readOnly: true
          description: The effective access level the user has for this object
        supports_webhooks:
          type: boolean
          readOnly: true
      required:
      - access_method
      - account_id
      - client_secret
      - created_at
      - created_by
      - engine
      - id
      - last_run_at
      - latest_error
      - revenue_analytics_config
      - schemas
      - source_type
      - status
      - supports_webhooks
      - user_access_level
    PatchedExternalDataSourceSerializers:
      type: object
      description: Mixin for serializers to add user access control fields
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        created_by:
          type: string
          nullable: true
          readOnly: true
        created_via:
          allOf:
          - $ref: '#/components/schemas/CreatedViaEnum'
          description: 'How this source was created. Defaults to `api` on create when omitted. `web` for the in-app UI, `api` for direct API callers, `mcp` for agent/MCP tool calls. Ignored on update.


            * `web` - web

            * `api` - api

            * `mcp` - mcp'
        status:
          type: string
          readOnly: true
        client_secret:
          type: string
          writeOnly: true
        account_id:
          type: string
          writeOnly: true
        source_type:
          allOf:
          - $ref: '#/components/schemas/ExternalDataSourceTypeEnum'
          readOnly: true
        latest_error:
          type: string
          nullable: true
          readOnly: true
        prefix:
          type: string
          nullable: true
          maxLength: 100
        description:
          type: string
          nullable: true
          maxLength: 400
        access_method:
          allOf:
          - $ref: '#/components/schemas/AccessMethodEnum'
          readOnly: true
        engine:
          readOnly: true
          nullable: true
          description: 'Backend engine detected for the direct connection.


            * `duckdb` - duckdb

            * `postgres` - postgres'
          oneOf:
          - $ref: '#/components/schemas/EngineEnum'
          - $ref: '#/components/schemas/NullEnum'
        last_run_at:
          type: string
          nullable: true
          readOnly: true
        schemas:
          type: array
          items:
            type: object
            additionalProperties: true
          readOnly: true
        job_inputs:
          nullable: true
        revenue_analytics_config:
          allOf:
          - $ref: '#/components/schemas/ExternalDataSourceRevenueAnalyticsConfig'
          readOnly: true
        user_access_level:
          type: string
          nullable: true
          readOnly: true
          description: The effective access level the user has for this object
        supports_webhooks:
          type: boolean
          readOnly: true
    DataWarehouseSavedQuery:
      type: object
      description: 'Shared methods for DataWarehouseSavedQuery serializers.


        This mixin is intended to be used with serializers.ModelSerializer subclasses.'
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        deleted:
          type: boolean
          nullable: true
        name:
          type: string
          description: Unique name for the view. Used as the table name in HogQL queries and the node name in the data modeling Node.
          maxLength: 128
        query:
          nullable: true
          description: 'HogQL query definition as a JSON object with a "query" key containing the SQL string and a "kind" key containing the query type. Example: {"query": "SELECT * FROM events LIMIT 100", "kind": "HogQLQuery"}'
        created_by:
          allOf:
          - $ref: '#/components/schemas/UserBasic'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        sync_frequency:
          type: string
          nullable: true
          readOnly: true
        columns:
          type: array
          items:
            type: object
            additionalProperties: true
          readOnly: true
        status:
          readOnly: true
          nullable: true
          description: 'The status of when this SavedQuery last ran.


            * `Cancelled` - Cancelled

            * `Modified` - Modified

            * `Completed` - Completed

            * `Failed` - Failed

            * `Running` - Running'
          oneOf:
          - $ref: '#/components/schemas/SavedQueryStatusEnum'
          - $ref: '#/components/schemas/NullEnum'
        last_run_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        managed_viewset_kind:
          type: string
          nullable: true
          readOnly: true
        folder_id:
          type: string
          format: uuid
          nullable: true
          description: Optional folder ID used to organize this view in the SQL editor sidebar.
        folder_name:
          type: string
          readOnly: true
          nullable: true
          description: Folder name used to organize this view in the SQL editor sidebar.
        latest_error:
          type: string
          readOnly: true
          nullable: true
        edited_history_id:
          type: string
          writeOnly: true
          nullable: true
          description: Activity log ID from the last known edit. Used for conflict detection.
        latest_history_id:
          type: integer
          nullable: true
          readOnly: true
        soft_update:
          type: boolean
          writeOnly: true
          nullable: true
          description: If true, skip column inference and validation. For saving drafts.
        dag_id:
          type: string
          format: uuid
          writeOnly: true
          nullable: true
          description: Optional DAG to place this view into
        is_materialized:
          type: boolean
          readOnly: true
          nullable: true
        origin:
          readOnly: true
          nullable: true
          description: 'Where this SavedQuery is created.


            * `data_warehouse` - Data Warehouse

            * `endpoint` - Endpoint

            * `managed_viewset` - Managed Viewset'
          oneOf:
          - $ref: '#/components/schemas/OriginEnum'
          - $ref: '#/components/schemas/NullEnum'
        is_test:
          type: boolean
          description: Whether this view is for testing only and will auto-expire.
        expires_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          description: When this test view should be automatically deleted.
        user_access_level:
          type: string
          nullable: true
          readOnly: true
          description: The effective access level the user has for this object
      required:
      - columns
      - created_at
      - created_by
      - expires_at
      - folder_name
      - id
      - is_materialized
      - last_run_at
      - latest_error
      - latest_history_id
      - managed_viewset_kind
      - name
      - origin
      - status
      - sync_frequency
      - user_access_level
    SyncTypeEnum:
      enum:
      - full_refresh
      - incremental
      - append
      - webhook
      - cdc
      type: string
      description: '* `full_refresh` - full_refresh

        * `incremental` - incremental

        * `append` - append

        * `webhook` - webhook

        * `cdc` - cdc'
    PatchedInsightVariable:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: UUID of the SQL variable.
        name:
          type: string
          description: Human-readable name for the SQL variable.
          maxLength: 400
        type:
          allOf:
          - $ref: '#/components/schemas/InsightVariableTypeEnum'
          description: 'Variable type. Controls how the value is rendered and substituted in HogQL.


            * `String` - String

            * `Number` - Number

            * `Boolean` - Boolean

            * `List` - List

            * `Date` - Date'
        default_value:
          nullable: true
          description: Default value used when a query references this variable.
        created_by:
          type: integer
          readOnly: true
          nullable: true
          description: ID of the user who created the SQL variable.
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: Timestamp when the SQL variable was created.
        code_name:
          type: string
          readOnly: true
          nullable: true
          description: Generated code-safe name used in HogQL as {variables.code_name}. Derived from name.
        values:
          nullable: true
          description: Allowed values for List variables. Null for other variable types.
    BlankEnum:
      enum:
      - ''
    AccessMethodEnum:
      enum:
      - warehouse
      - direct
      type: string
      description: '* `warehouse` - warehouse

        * `direct` - direct'
    ExternalDataSourceConnectionOption:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        prefix:
          type: string
          readOnly: true
          nullable: true
        engine:
          readOnly: true
          nullable: true
          description: 'Backend engine detected for the direct connection.


            * `duckdb` - duckdb

            * `postgres` - postgres'
          oneOf:
          - $ref: '#/components/schemas/EngineEnum'
          - $ref: '#/components/schemas/NullEnum'
      required:
      - engine
      - id
      - prefix
  parameters:
    EnvironmentIdPath:
      in: path
      name: environment_id
      required: true
      schema:
        type: string
      description: Deprecated. Use /api/projects/{project_id}/ instead.
    ProjectIdPath:
      in: path
      name: project_id
      required: true
      schema:
        type: string
      description: Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
  securitySchemes:
    PersonalAPIKeyAuth:
      type: http
      scheme: bearer
x-tagGroups:
- name: All endpoints
  tags:
  - LLM Analytics
  - actions
  - activity_log
  - activity_logs
  - advanced_activity_logs
  - alerts
  - annotations
  - approval_policies
  - batch_exports
  - cdp
  - change_requests
  - code
  - code-invites
  - cohorts
  - comments
  - conversations
  - core
  - customer_analytics
  - customer_journeys
  - customer_profile_configs
  - dashboard_templates
  - dashboards
  - data_color_themes
  - data_modeling_jobs
  - data_warehouse
  - dataset_items
  - datasets
  - desktop_recordings
  - domains
  - early_access_feature
  - early_access_features
  - elements
  - endpoints
  - environments
  - error_tracking
  - evaluation_runs
  - evaluations
  - event_definitions
  - event_filter
  - event_schemas
  - events
  - experiment_holdouts
  - experiment_saved_metrics
  - experiments
  - exports
  - external_data_schemas
  - external_data_sources
  - feature_flags
  - file_system
  - file_system_shortcut
  - flag_value
  - groups
  - groups_types
  - health_issues
  - heatmap_screenshots
  - heatmaps
  - hog_flows
  - hog_function_templates
  - hog_functions
  - insight_variables
  - insights
  - integrations
  - invites
  - js-snippet
  - legal_documents
  - lineage
  - live_debugger_breakpoints
  - llm_analytics
  - llm_prompts
  - llm_skills
  - logs
  - managed_viewsets
  - max
  - max_tools
  - mcp_server_installations
  - mcp_servers
  - mcp_store
  - mcp_tools
  - members
  - notebooks
  - oauth_applications
  - object_media_previews
  - organizations
  - persisted_folder
  - persons
  - platform_features
  - plugin_configs
  - product_analytics
  - product_tours
  - project_secret_api_keys
  - projects
  - property_definitions
  - proxy_records
  - public_hog_function_templates
  - query
  - replay
  - reverse_proxy
  - role_external_references
  - roles
  - sandbox-environments
  - sandbox_environments
  - saved
  - schema_property_groups
  - sdk_doctor
  - session_group_summaries
  - session_recording_playlists
  - session_recordings
  - session_summaries
  - sessions
  - signals
  - subscriptions
  - surveys
  - taggers
  - task-automations
  - task-runs
  - task_automations
  - tasks
  - uploaded_media
  - user_home_settings
  - user_interviews
  - users
  - visual_review
  - warehouse_dag
  - warehouse_model_paths
  - warehouse_saved_queries
  - warehouse_saved_query_folders
  - warehouse_tables
  - warehouse_view_link
  - warehouse_view_links
  - web_analytics
  - web_experiments
  - web_vitals
  - welcome
  - workflows