---
title: "Get Default Columns"
method: GET
path: "/data_warehouse/default-columns"
---

# Get Default Columns

`GET /data_warehouse/default-columns`

The columns a connection syncs while it has none of its own.

The wizard seeds a customized list from these, so the set stays defined in
one place rather than being mirrored in the client. Each is named with the
column it already writes: a connection that customizes keeps the table it
had, and from then on the name is the column.

## Headers

- `Authorization` string, nullable
- `X-User-Id` string, nullable

## Cookies

- `session_id` string, nullable

## Response `200`

Successful Response

- DefaultColumnsResponse
  - `columns` DataWarehouseColumn[], required
    - `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
        - `name` string, nullable
        - `hidden` boolean, nullable
        - `id` string
        - `filter` MetricFilter
          - `comparator` 'greater_than' | 'less_than', required
          - `value` number, required
        - `type` 'event'
        - `event_name` string, nullable
        - `aggregate` union, required
          - BasicEventMetricAggregate
            - `type` 'events' | 'sessions' | 'profiles' | 'session_conversion_rate' | 'profile_conversion_rate' | 'session_revenue' | 'new_customer_rate' | 'bounce_rate' | 'session_duration' | 'new_visitor_sessions' | 'new_visitor_sessions_rate' | 'cpa' | 'roas' | 'mer' | 'acos' | 'poas' | 'net_profit' | 'gross_margin' | 'contribution_margin' | 'net_margin', required
          - BasicProductMetricAggregate
            - `type` 'product_events' | 'product_sessions' | 'product_profiles' | 'product_session_conversion_rate' | 'product_profile_conversion_rate' | 'product_session_revenue' | 'product_new_customer_rate' | 'product_new_visitor_sessions' | 'product_new_visitor_sessions_rate' | 'product_cpa' | 'product_roas' | 'product_acos' | 'product_poas' | 'product_gross_margin' | 'product_contribution_margin' | 'product_net_profit' | 'product_net_margin' | 'product_quantity', required
          - CustomPropertyEventMetricAggregate
            - `type` 'custom_property'
            - `property_name` union, required
              - …
            - `operation_type` 'count_unique' | 'sum' | 'avg' | 'median' | 'min' | 'max' | 'p75' | 'p90' | 'p95' | 'p99', required
          - CustomPropertyProductMetricAggregate
            - `type` 'custom_property_product'
            - `property_name` union, required
              - …
            - `operation_type` 'count_unique' | 'sum' | 'avg' | 'median' | 'min' | 'max' | 'p75' | 'p90' | 'p95' | 'p99', required
        - `filters` union[]
          - union
            - EventPropertyFilter
              - …
            - EventSourceFilter
              - …
            - AdPlatformPropertyFilter
              - …
            - AdPlatformSourceFilter
              - …
            - TouchpointFilter
              - …
            - CustomDimensionFilter
              - …
            - AdPropertiesFilter
              - …
        - `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
      - AdPlatformMetric
        - `name` string, nullable
        - `hidden` boolean, nullable
        - `id` string
        - `filter` MetricFilter
          - `comparator` 'greater_than' | 'less_than', required
          - `value` number, required
        - `type` 'ad_platform'
        - `column` union, required
          - AdPlatformClickMetric
            - `type` 'clicks'
            - `aggregate_type` 'sum' | 'ctr' | 'cpc', required
          - AdPlatformSpendMetric
            - `type` 'spend'
            - `aggregate_type` 'sum'
          - AdPlatformImpressionsMetric
            - `type` 'impressions'
            - `aggregate_type` 'sum' | 'cpm', required
          - AdPlatformPurchaseConversionsMetric
            - `type` 'purchase_conversions'
            - `aggregate_type` 'sum' | 'cpa' | 'revenue' | 'roas' | 'acos', required
          - AdPlatformCustomConversionsMetric
            - `type` 'custom_conversions'
            - `aggregate_type` 'sum' | 'cpa' | 'revenue' | 'roas' | 'acos', required
            - `conversion_name` string, nullable
            - `channel` string, nullable
          - AdPlatformBuiltinMetric — Hard-coded built-in metrics, currently only NB NV%
            - `type` 'builtin'
            - `metric` 'northbeam_nv_rate', required
        - `filters` union[]
          - union
            - EventPropertyFilter
              - …
            - EventSourceFilter
              - …
            - AdPlatformPropertyFilter
              - …
            - AdPlatformSourceFilter
              - …
            - TouchpointFilter
              - …
            - CustomDimensionFilter
              - …
            - AdPropertiesFilter
              - …
      - FormulaMetric
        - `name` string, nullable
        - `hidden` boolean, nullable
        - `id` string
        - `filter` MetricFilter
          - `comparator` 'greater_than' | 'less_than', required
          - `value` number, required
        - `type` 'formula'
        - `formula` string, required
    - `metric_filters` union[]
      - union
        - EventPropertyFilter
          - `type` 'event'
          - `scope` 'event' | 'profile' | 'session' | 'product', required
          - `property_name` union, required
            - string
            - union
              - …
          - `operator` union, required
            - StringPropertyOperator
              - …
            - ListOfStringsPropertyOperator
              - …
            - NumericPropertyOperator
              - …
            - BooleanPropertyOperator
              - …
            - IsSetPropertyOperator
              - …
        - EventSourceFilter
          - `type` 'event_source'
          - `datasource_id` union
            - integer
            - integer[]
          - `pixel_id` union
            - integer
            - integer[]
        - AdPlatformPropertyFilter
          - `type` 'ad_platform'
          - `property` 'channel_group' | 'channel' | 'campaign' | 'adset' | 'ad', required
          - `operator` union, required
            - StringPropertyOperator
              - …
            - IsTouchpointOperator
              - …
        - AdPlatformSourceFilter
          - `type` 'ad_platform_source'
          - `ad_platform_id` union, required
            - integer
            - integer[]
        - TouchpointFilter
          - `type` 'touchpoint'
          - `property` 'channel_group' | 'channel' | 'campaign' | 'adset' | 'ad', required
          - `operator` union, required
            - StringPropertyOperator
              - …
            - IsTouchpointOperator
              - …
          - `legacy` boolean
        - CustomDimensionFilter
          - `type` 'custom_dimension'
          - `custom_dimension_id` integer, required
          - `values` string[], required
        - AdPropertiesFilter
          - `type` 'ad_properties'
          - `property` 'ad_created_at' | 'ad_status' | 'ad_landing_url', required
          - `operator` union, required
            - DateRangePropertyOperator
              - …
            - BooleanPropertyOperator
              - …
            - StringPropertyOperator
              - …
    - `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

## 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)