---
title: "Get Data Warehouses"
method: GET
path: "/data_warehouse"
---

# Get Data Warehouses

`GET /data_warehouse`

## Query parameters

- `limit` integer
- `page` integer
- `filters[]` string[], nullable
- `tz` string, nullable
- `start_of_week` 0 | 1

## Headers

- `Authorization` string, nullable
- `X-User-Id` string, nullable
- `X-Browser-Time-Zone` string, nullable

## Cookies

- `session_id` string, nullable

## Response `200`

Successful Response

- ListDataWarehouseResponse
  - `items` DataWarehouseResponse[], required
    - `id` integer, required
    - `name` string, required
    - `description` string, nullable, required
    - `tags` string[], nullable, required
    - `config` union, required
      - BigQueryDataWarehouseConfig
        - `app` 'bigquery'
        - `filters` AllOfFilters
          - `all_of` AnyOfFilters[]
            - `any_of` union[]
              - …
        - `columns` DataWarehouseColumn[], nullable
          - `name` string, required
          - `type` 'builtin' | 'custom', required — How a stored metric points at its definition. A builtin names one we own and picks up later improvements to it; a custom one carries the whole definition in a `CustomMetricConfig`.
          - `metric_key` string, nullable
          - `metric_config` union
            - EventMetric
              - …
            - AdPlatformMetric
              - …
            - FormulaMetric
              - …
          - `metric_filters` union[]
            - union
              - …
          - `metric_attribution` ConvergeApiAttributionsAttribution
            - `mode` 'click_time' | 'conversion_time'
            - `model` 'first_touch' | 'first_touch_paid' | 'inv_j_shaped' | 'j_shaped' | 'j_shaped_paid' | 'last_touch' | 'last_touch_paid' | 'linear' | 'participation' | 'time_decay' | 'inv_time_decay' | 'u_shaped' | 'direct_session' | 'inv_j_shaped_paid' | 'top_of_funnel'
            - `window` integer
            - `lookback` integer, nullable
          - `icon` CustomIcon
            - `icon` string, required
            - `color` string, nullable
        - `private_key` string, password, required
        - `private_key_id` string, password, required
        - `client_email` string, required
        - `project_id` string, required
        - `dataset_id` string, required
        - `table_id` string, required
        - `staging_table_id` string, nullable
      - DummyDataWarehouseConfig
        - `app` 'dummy'
        - `filters` AllOfFilters
          - `all_of` AnyOfFilters[]
            - `any_of` union[]
              - …
        - `columns` DataWarehouseColumn[], nullable
          - `name` string, required
          - `type` 'builtin' | 'custom', required — How a stored metric points at its definition. A builtin names one we own and picks up later improvements to it; a custom one carries the whole definition in a `CustomMetricConfig`.
          - `metric_key` string, nullable
          - `metric_config` union
            - EventMetric
              - …
            - AdPlatformMetric
              - …
            - FormulaMetric
              - …
          - `metric_filters` union[]
            - union
              - …
          - `metric_attribution` ConvergeApiAttributionsAttribution
            - `mode` 'click_time' | 'conversion_time'
            - `model` 'first_touch' | 'first_touch_paid' | 'inv_j_shaped' | 'j_shaped' | 'j_shaped_paid' | 'last_touch' | 'last_touch_paid' | 'linear' | 'participation' | 'time_decay' | 'inv_time_decay' | 'u_shaped' | 'direct_session' | 'inv_j_shaped_paid' | 'top_of_funnel'
            - `window` integer
            - `lookback` integer, nullable
          - `icon` CustomIcon
            - `icon` string, required
            - `color` string, nullable
    - `active` boolean, required
    - `start_date` string, date, nullable
    - `interval_seconds` integer, required
    - `creator` AccountSchema, required
      - `id` integer, required
      - `email` string, required
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `profile_picture_url` string, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `last_run` RunModel
      - `id` integer, required
      - `started_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `finished_at` string, date-time, nullable
      - `status` 'cancelled' | 'completed' | 'failed' | 'running', required
      - `progress` number
      - `failure` DataWarehouseFailure
        - `type` 'authentication_error' | 'configuration_error' | 'connection_error' | 'response_error' | 'unknown_error', required
        - `description` string, required
        - `status_code` union
          - integer
          - string
        - `message` string, nullable
  - `count` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/runconverge/apis/fastapi.md) · [All operations](https://skmtc.dev/runconverge/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runconverge/fastapi/revisions/1452e350bd1d/schema)