---
title: "Patch Attribution Dashboard V4"
method: PATCH
path: "/attribution/dashboard-v4/{dashboard_id}"
---

# Patch Attribution Dashboard V4

`PATCH /attribution/dashboard-v4/{dashboard_id}`

## Path parameters

- `dashboard_id` integer, required

## Headers

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

## Cookies

- `session_id` string, nullable

## Request body

- PatchAttributionDashboardRequest
  - `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
  - `currency` string, nullable
  - `dashboard_metadata` AttributionDashboardMetadata
    - `column_widths` object
    - `sorting` AttributionDashboardSorting
      - `id` string, required
      - `direction` 'asc' | 'desc', required
    - `chart_metrics` string[]
    - `chart_visible` boolean, nullable
  - `compare` string, nullable
  - `breakdown` 'channel_group' | 'channel' | 'campaign' | 'adset' | 'ad'
  - `breakdown_selection` AttributionBreakdownSelection
  - `date_range` DateRangeQuery
    - `since` union, required
      - string, date
      - string, date-time
      - string
    - `until` union
      - string, date
      - string, date-time
      - string
  - `name` string, nullable
  - `description` string, nullable
  - `icon` CustomIcon
    - `icon` string, required
    - `color` string, nullable
  - `filters` union[], nullable
    - union
      - EventPropertyFilter
        - `type` 'event'
        - `scope` 'event' | 'profile' | 'session' | 'product', required
        - `property_name` union, required
          - string
          - union
            - RevenueProperty
              - …
            - TaxProperty
              - …
            - DiscountProperty
              - …
            - ShippingProperty
              - …
            - NetRevenueAfterTaxProperty
              - …
            - NetRevenueAfterTaxAndShippingProperty
              - …
            - ProductIDsProperty
              - …
            - VariantIDsProperty
              - …
            - ProductSKUsProperty
              - …
            - ProductNamesProperty
              - …
            - ProductBundleIds
              - …
            - ProductBundleNames
              - …
            - NumberOfItemsProperty
              - …
            - PaymentMethodProperty
              - …
            - SalesChannelTypeProperty
              - …
            - URLProperty
              - …
            - FullURLProperty
              - …
            - ReferrerProperty
              - …
            - LandingURLProperty
              - …
            - FullLandingURLProperty
              - …
            - LandingURLDomainProperty
              - …
            - LandingURLPathProperty
              - …
            - TimezoneProperty
              - …
            - LanguageProperty
              - …
            - TitleProperty
              - …
            - DeviceBrandProperty
              - …
            - DeviceModelProperty
              - …
            - DeviceTypeProperty
              - …
            - OSProperty
              - …
            - BrowserProperty
              - …
            - GenderGuessProperty
              - …
            - GeoIPCityNameProperty
              - …
            - GeoIPCountryNameProperty
              - …
            - GeoIPCountryCodeProperty
              - …
            - GeoIPRegionNameProperty
              - …
            - GeoIPZipCodeProperty
              - …
            - IsCustomerProperty
              - …
            - IsNewVisitorProperty
              - …
            - UtmSourceMedium
              - …
            - FullSessionReferrerProperty
              - …
            - ProfileIDProperty
              - …
            - OrderIDProperty
              - …
            - ProductPriceProperty
              - …
            - ProductQuantityProperty
              - …
            - ProductRevenueProperty
              - …
            - ProductDiscountProperty
              - …
            - ProductTaxesProperty
              - …
            - ProductShippingProperty
              - …
            - ProductNetRevenueProperty
              - …
            - COGSProperty
              - …
            - GrossProfitProperty
              - …
            - PaymentProcessingFeeProperty
              - …
            - ShippingCostProperty
              - …
            - GrossRevenueProperty
              - …
            - ContributionProfitProperty
              - …
        - `operator` union, required
          - StringPropertyOperator
            - `property_type` 'string'
            - `comparator` 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'contains_all' | 'not_contains_all' | 'starts_with' | 'ends_with', required
            - `ignore_case` boolean
            - `value` union, required
              - …
          - ListOfStringsPropertyOperator
            - `property_type` 'list_of_strings'
            - `comparator` 'contains' | 'not_contains' | 'contains_all' | 'not_contains_all' | 'includes_any_contains' | 'is_set' | 'not_set', required
            - `ignore_case` boolean
            - `value` string[], required
          - NumericPropertyOperator
            - `property_type` 'numeric'
            - `comparator` 'equals' | 'not_equals' | 'greater_than' | 'less_than' | 'greater_than_or_equal' | 'less_than_or_equal', required
            - `value` union, required
              - …
          - BooleanPropertyOperator
            - `property_type` 'boolean'
            - `comparator` 'equals' | 'not_equals', required
            - `value` boolean
          - IsSetPropertyOperator
            - `comparator` 'is_set' | 'not_set', required
      - 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
            - `property_type` 'string'
            - `comparator` 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'contains_all' | 'not_contains_all' | 'starts_with' | 'ends_with', required
            - `ignore_case` boolean
            - `value` union, required
              - …
          - IsTouchpointOperator
            - `comparator` 'is_touchpoint' | 'is_not_touchpoint', required
            - `value` union, required
              - …
            - `exact_value` boolean
      - 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
            - `property_type` 'string'
            - `comparator` 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'contains_all' | 'not_contains_all' | 'starts_with' | 'ends_with', required
            - `ignore_case` boolean
            - `value` union, required
              - …
          - IsTouchpointOperator
            - `comparator` 'is_touchpoint' | 'is_not_touchpoint', required
            - `value` union, required
              - …
            - `exact_value` boolean
        - `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
            - `value` DateRangeQuery, required
              - …
          - BooleanPropertyOperator
            - `property_type` 'boolean'
            - `comparator` 'equals' | 'not_equals', required
            - `value` boolean
          - StringPropertyOperator
            - `property_type` 'string'
            - `comparator` 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'contains_all' | 'not_contains_all' | 'starts_with' | 'ends_with', required
            - `ignore_case` boolean
            - `value` union, required
              - …
  - `metrics` union[], nullable
    - 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

## Response `200`

Successful Response

- GetAttributionDashboardResponse
  - `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
  - `currency` string, nullable
  - `dashboard_metadata` AttributionDashboardMetadata
    - `column_widths` object
    - `sorting` AttributionDashboardSorting
      - `id` string, required
      - `direction` 'asc' | 'desc', required
    - `chart_metrics` string[]
    - `chart_visible` boolean, nullable
  - `compare` string, nullable
  - `breakdown` 'channel_group' | 'channel' | 'campaign' | 'adset' | 'ad'
  - `breakdown_selection` AttributionBreakdownSelection
  - `date_range` DateRangeQuery
    - `since` union, required
      - string, date
      - string, date-time
      - string
    - `until` union
      - string, date
      - string, date-time
      - string
  - `name` string, required
  - `description` string, required
  - `icon` CustomIcon
    - `icon` string, required
    - `color` string, nullable
  - `id` integer, required
  - `is_default` boolean, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `filters` union[], required
    - union
      - EventPropertyFilter
        - `type` 'event'
        - `scope` 'event' | 'profile' | 'session' | 'product', required
        - `property_name` union, required
          - string
          - union
            - RevenueProperty
              - …
            - TaxProperty
              - …
            - DiscountProperty
              - …
            - ShippingProperty
              - …
            - NetRevenueAfterTaxProperty
              - …
            - NetRevenueAfterTaxAndShippingProperty
              - …
            - ProductIDsProperty
              - …
            - VariantIDsProperty
              - …
            - ProductSKUsProperty
              - …
            - ProductNamesProperty
              - …
            - ProductBundleIds
              - …
            - ProductBundleNames
              - …
            - NumberOfItemsProperty
              - …
            - PaymentMethodProperty
              - …
            - SalesChannelTypeProperty
              - …
            - URLProperty
              - …
            - FullURLProperty
              - …
            - ReferrerProperty
              - …
            - LandingURLProperty
              - …
            - FullLandingURLProperty
              - …
            - LandingURLDomainProperty
              - …
            - LandingURLPathProperty
              - …
            - TimezoneProperty
              - …
            - LanguageProperty
              - …
            - TitleProperty
              - …
            - DeviceBrandProperty
              - …
            - DeviceModelProperty
              - …
            - DeviceTypeProperty
              - …
            - OSProperty
              - …
            - BrowserProperty
              - …
            - GenderGuessProperty
              - …
            - GeoIPCityNameProperty
              - …
            - GeoIPCountryNameProperty
              - …
            - GeoIPCountryCodeProperty
              - …
            - GeoIPRegionNameProperty
              - …
            - GeoIPZipCodeProperty
              - …
            - IsCustomerProperty
              - …
            - IsNewVisitorProperty
              - …
            - UtmSourceMedium
              - …
            - FullSessionReferrerProperty
              - …
            - ProfileIDProperty
              - …
            - OrderIDProperty
              - …
            - ProductPriceProperty
              - …
            - ProductQuantityProperty
              - …
            - ProductRevenueProperty
              - …
            - ProductDiscountProperty
              - …
            - ProductTaxesProperty
              - …
            - ProductShippingProperty
              - …
            - ProductNetRevenueProperty
              - …
            - COGSProperty
              - …
            - GrossProfitProperty
              - …
            - PaymentProcessingFeeProperty
              - …
            - ShippingCostProperty
              - …
            - GrossRevenueProperty
              - …
            - ContributionProfitProperty
              - …
        - `operator` union, required
          - StringPropertyOperator
            - `property_type` 'string'
            - `comparator` 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'contains_all' | 'not_contains_all' | 'starts_with' | 'ends_with', required
            - `ignore_case` boolean
            - `value` union, required
              - …
          - ListOfStringsPropertyOperator
            - `property_type` 'list_of_strings'
            - `comparator` 'contains' | 'not_contains' | 'contains_all' | 'not_contains_all' | 'includes_any_contains' | 'is_set' | 'not_set', required
            - `ignore_case` boolean
            - `value` string[], required
          - NumericPropertyOperator
            - `property_type` 'numeric'
            - `comparator` 'equals' | 'not_equals' | 'greater_than' | 'less_than' | 'greater_than_or_equal' | 'less_than_or_equal', required
            - `value` union, required
              - …
          - BooleanPropertyOperator
            - `property_type` 'boolean'
            - `comparator` 'equals' | 'not_equals', required
            - `value` boolean
          - IsSetPropertyOperator
            - `comparator` 'is_set' | 'not_set', required
      - 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
            - `property_type` 'string'
            - `comparator` 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'contains_all' | 'not_contains_all' | 'starts_with' | 'ends_with', required
            - `ignore_case` boolean
            - `value` union, required
              - …
          - IsTouchpointOperator
            - `comparator` 'is_touchpoint' | 'is_not_touchpoint', required
            - `value` union, required
              - …
            - `exact_value` boolean
      - 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
            - `property_type` 'string'
            - `comparator` 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'contains_all' | 'not_contains_all' | 'starts_with' | 'ends_with', required
            - `ignore_case` boolean
            - `value` union, required
              - …
          - IsTouchpointOperator
            - `comparator` 'is_touchpoint' | 'is_not_touchpoint', required
            - `value` union, required
              - …
            - `exact_value` boolean
        - `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
            - `value` DateRangeQuery, required
              - …
          - BooleanPropertyOperator
            - `property_type` 'boolean'
            - `comparator` 'equals' | 'not_equals', required
            - `value` boolean
          - StringPropertyOperator
            - `property_type` 'string'
            - `comparator` 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'contains_all' | 'not_contains_all' | 'starts_with' | 'ends_with', required
            - `ignore_case` boolean
            - `value` union, required
              - …
  - `metrics` union[], required
    - 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

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