--- title: "Update Dashboard Widget" method: PATCH path: "/console/v1/dashboards/{id}/widgets/{widgetId}" tags: ["Dashboards"] --- # Update Dashboard Widget `PATCH /console/v1/dashboards/{id}/widgets/{widgetId}` ## Request - Base URL: `https://statsigapi.net` - URL: `https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}` - Auth: API key in header `STATSIG-API-KEY` Edit one widget using a full supported definition or sparse metadata/layout/query patch and the dashboard revision. Query and arrays replace their complete previous values. Omitted fields remain unchanged. Unsupported widgets allow layout-only edits. Read again after a revision conflict. ## Path parameters - `id` string, required - `widgetId` string, required ## Request body - UpdateDashboardWidgetDto - `revision` string, required: Include the `revision` returned by an editable or references read. Read the dashboard again after a revision conflict. - `widget` union, required - union - object - `type` 'text', required - `title` string, required - `content` string, required - `width` integer - `height` integer - `id` string - `description` string - `color` string, nullable - `layout` object - `row` integer, required - `column` integer, required - `date_range` object, nullable - `start_ds` string, nullable - `end_ds` string, nullable - `start_offset_days` number, nullable - `end_offset_days` number, nullable - object - `type` 'header', required - `title` string, required - `color` string, nullable - `width` integer - `height` integer - `id` string - `description` string - `layout` object - `row` integer, required - `column` integer, required - `date_range` object, nullable - `start_ds` string, nullable - `end_ds` string, nullable - `start_offset_days` number, nullable - `end_offset_days` number, nullable - object - `type` 'timeseries', required - `title` string, required - `description` string - `color` string, nullable - `query` DashboardSharedSchema8, required - `source` DashboardSharedSchema14 - `type` 'event', required - `event_name` string, required - `filters` object[] - … - `sources` DashboardSharedSchema14[] - `type` 'event', required - `event_name` string, required - `filters` object[] - … - `aggregation` object, required - `type` unknown, required - `property` object - … - `unit_type` string - `group_bys` DashboardSharedSchema7[] - `key` string, required - `column` string, required: Property namespace, such as `user_object` or `metric_source_metadata`. - `metric_source_column` string - `source` object, nullable - … - `viz` object - `chart_type` 'line' | 'timeseries-bar' | 'horizontal-bar' | 'grouped-bar' | 'pie' | 'geo-map' | 'samples' | 'stacked-line' | 'single-value' | 'conversion-rate' | 'conversions' | 'table', required - `date` union - … - `time_range` object - … - `granularity` 'month' | 'week' | 'day' | 'hour' | '5m' | '30m' | '1m' | 'auto' - `time_comparison` number - `time_comparison_hours` number - `rollup_type` 'none' | 'avg' | 'sum' | 'cumulative_sum' - `rollup_days` number - `y_axis_type` 'numbers' | 'monetary' | 'percentage' | 'time' | 'time_ns' | 'time_us' | 'time_ms' | 'decimal_bytes' | 'binary_bytes' | 'bits' | 'time_s' | 'percentage_ratio' - `cum_sum_rollup` 'unique' | 'all' - `single_value_type` 'latest' | 'overall' - `usage_interval_number_of_days` number - `show_delta_comparison_view` boolean - `is_time_comparison_last_period` boolean - `show_grouped_percentage_breakdown` boolean - `chart_view` 'chart' | 'legend' | 'chart_legend' - `show_percent_difference_compare_option` boolean - `use_widget_granularity_in_dashboard` boolean - `filters` object[] - `property` DashboardSharedSchema7, required - … - `operator` 'ANY_OF' | 'CONTAINS' | 'EQ' | 'GT' | 'LT' | 'GTE' | 'LTE' | 'IS_NOT_NULL' | 'IS_NULL' | 'NONE_OF' | 'NOT_CONTAINS' | 'SQL_FILTER' | 'STARTS_WITH' | 'ENDS_WITH' | 'AFTER_EXPOSURE' | 'BEFORE_EXPOSURE' | 'IS_TRUE' | 'IS_FALSE' | 'INCLUDED' | 'NOT_INCLUDED', required - `values` string[] - `label` string - `cohorts` union[] - union - … - `options` DashboardSharedSchema4 - `exposure_query_mode` 'all' | 'daily_first' | 'first' | 'fresh' - `group_by_limit` integer - `group_by_query_limit` integer - `separate_chart_per_metric` boolean - `force_start_y_at_zero` boolean - `include_annotations` boolean - `show_all_annotations` boolean - `annotation_filters` object - … - `sorting` object - … - `sampling_enabled` boolean - `include_test_events` boolean - `filter_bot_data` boolean - `enable_id_resolution` boolean - `is_precomputed_only` boolean - `default_id_type` string, nullable - `show_table_only` boolean - `width` integer - `height` integer - `id` string - `layout` object - `row` integer, required - `column` integer, required - `date_range` object, nullable - `start_ds` string, nullable - `end_ds` string, nullable - `start_offset_days` number, nullable - `end_offset_days` number, nullable - object - `type` 'drilldown', required - `title` string, required - `description` string - `color` string, nullable - `query` DashboardSharedSchema9, required - `filters` object[] - `property` DashboardSharedSchema7, required - … - `operator` 'ANY_OF' | 'CONTAINS' | 'EQ' | 'GT' | 'LT' | 'GTE' | 'LTE' | 'IS_NOT_NULL' | 'IS_NULL' | 'NONE_OF' | 'NOT_CONTAINS' | 'SQL_FILTER' | 'STARTS_WITH' | 'ENDS_WITH' | 'AFTER_EXPOSURE' | 'BEFORE_EXPOSURE' | 'IS_TRUE' | 'IS_FALSE' | 'INCLUDED' | 'NOT_INCLUDED', required - `values` string[] - `label` string - `cohorts` union[] - union - … - `unit_type` string - `options` DashboardSharedSchema4 - `exposure_query_mode` 'all' | 'daily_first' | 'first' | 'fresh' - `group_by_limit` integer - `group_by_query_limit` integer - `separate_chart_per_metric` boolean - `force_start_y_at_zero` boolean - `include_annotations` boolean - `show_all_annotations` boolean - `annotation_filters` object - … - `sorting` object - … - `sampling_enabled` boolean - `include_test_events` boolean - `filter_bot_data` boolean - `enable_id_resolution` boolean - `is_precomputed_only` boolean - `default_id_type` string, nullable - `show_table_only` boolean - `series` DashboardSharedSchema2[], required - `id` string - `source` union, required - … - `definition` object - … - `unit_type` string - `filters` object[] - … - `group_bys` DashboardSharedSchema7[] - … - `alias` string - `hidden` boolean - `formulas` object[] - `id` string - `formula` string, required - `name` string - `hidden` boolean - `coalesce_nulls_as_zeroes` boolean - `highlight_as` 'error' | 'warning' - `group_bys` DashboardSharedSchema7[] - `key` string, required - `column` string, required: Property namespace, such as `user_object` or `metric_source_metadata`. - `metric_source_column` string - `source` object, nullable - … - `viz` object, required - `chart_type` 'line' | 'timeseries-bar' | 'horizontal-bar' | 'grouped-bar' | 'pie' | 'geo-map' | 'samples' | 'stacked-line' | 'single-value' | 'table', required - `date` union - … - `time_range` object - … - `granularity` 'month' | 'week' | 'day' | 'hour' | '5m' | '30m' | '1m' | 'auto' - `time_comparison` number - `time_comparison_hours` number - `rollup_type` 'none' | 'avg' | 'sum' | 'cumulative_sum' - `rollup_days` number - `y_axis_type` 'numbers' | 'monetary' | 'percentage' | 'time' | 'time_ns' | 'time_us' | 'time_ms' | 'decimal_bytes' | 'binary_bytes' | 'bits' | 'time_s' | 'percentage_ratio' - `cum_sum_rollup` 'unique' | 'all' - `single_value_type` 'latest' | 'overall' - `usage_interval_number_of_days` number - `show_delta_comparison_view` boolean - `is_time_comparison_last_period` boolean - `show_grouped_percentage_breakdown` boolean - `chart_view` 'chart' | 'legend' | 'chart_legend' - `show_percent_difference_compare_option` boolean - `use_widget_granularity_in_dashboard` boolean - `width` integer - `height` integer - `id` string - `layout` object - `row` integer, required - `column` integer, required - `date_range` object, nullable - `start_ds` string, nullable - `end_ds` string, nullable - `start_offset_days` number, nullable - `end_offset_days` number, nullable - object - `type` 'funnel', required - `title` string, required - `description` string - `color` string, nullable - `query` DashboardSharedSchema6, required - `filters` object[] - `property` DashboardSharedSchema7, required - … - `operator` 'ANY_OF' | 'CONTAINS' | 'EQ' | 'GT' | 'LT' | 'GTE' | 'LTE' | 'IS_NOT_NULL' | 'IS_NULL' | 'NONE_OF' | 'NOT_CONTAINS' | 'SQL_FILTER' | 'STARTS_WITH' | 'ENDS_WITH' | 'AFTER_EXPOSURE' | 'BEFORE_EXPOSURE' | 'IS_TRUE' | 'IS_FALSE' | 'INCLUDED' | 'NOT_INCLUDED', required - `values` string[] - `label` string - `cohorts` union[] - union - … - `unit_type` string - `options` DashboardSharedSchema4 - `exposure_query_mode` 'all' | 'daily_first' | 'first' | 'fresh' - `group_by_limit` integer - `group_by_query_limit` integer - `separate_chart_per_metric` boolean - `force_start_y_at_zero` boolean - `include_annotations` boolean - `show_all_annotations` boolean - `annotation_filters` object - … - `sorting` object - … - `sampling_enabled` boolean - `include_test_events` boolean - `filter_bot_data` boolean - `enable_id_resolution` boolean - `is_precomputed_only` boolean - `default_id_type` string, nullable - `show_table_only` boolean - `steps` union[], required - union - … - `conversion_window` object - `value` integer, required - `unit` 'second' | 'minute' | 'hour' | 'day', required - `chart_type` 'conversion-rate' | 'conversions' - `viz` object - `chart_type` 'line' | 'conversion-rate' | 'conversions', required - `date` union - … - `time_range` object - … - `granularity` 'month' | 'week' | 'day' | 'hour' | '5m' | '30m' | '1m' | 'auto' - `time_comparison` number - `time_comparison_hours` number - `rollup_type` 'none' | 'avg' | 'sum' | 'cumulative_sum' - `rollup_days` number - `y_axis_type` 'numbers' | 'monetary' | 'percentage' | 'time' | 'time_ns' | 'time_us' | 'time_ms' | 'decimal_bytes' | 'binary_bytes' | 'bits' | 'time_s' | 'percentage_ratio' - `cum_sum_rollup` 'unique' | 'all' - `single_value_type` 'latest' | 'overall' - `usage_interval_number_of_days` number - `show_delta_comparison_view` boolean - `is_time_comparison_last_period` boolean - `show_grouped_percentage_breakdown` boolean - `chart_view` 'chart' | 'legend' | 'chart_legend' - `show_percent_difference_compare_option` boolean - `use_widget_granularity_in_dashboard` boolean - `aggregation` 'daily' | 'overall' - `measurement` 'conversion_rate' | 'conversion_rate_over_time' | 'time_to_convert' - `is_sequential` boolean - `use_uniques_units` boolean - `group_bys` DashboardSharedSchema7[] - `key` string, required - `column` string, required: Property namespace, such as `user_object` or `metric_source_metadata`. - `metric_source_column` string - `source` object, nullable - … - `use_persistent_group_bys` boolean - `group_by_limit` integer - `sort_by_conversion_rate` boolean - `sort_order_is_descending` boolean - `time_to_convert_buckets` object - `range_min` number, required - `range_max` number, required - `interval_size` number, required - `bucket_units_min_max` 'second' | 'minute' | 'hour' | 'day', required - `bucket_units_bucket_size` 'second' | 'minute' | 'hour' | 'day', required - `time_to_convert_unit` 'second' | 'minute' | 'hour' | 'day' - `show_sum_property_value_last_step` boolean - `property_value_to_sum` string - `exclude_units_who_did_event` object - `events` object[], required - … - `between_steps` object - … - `width` integer - `height` integer - `id` string - `layout` object - `row` integer, required - `column` integer, required - `date_range` object, nullable - `start_ds` string, nullable - `end_ds` string, nullable - `start_offset_days` number, nullable - `end_offset_days` number, nullable - DashboardSharedSchema12 - `type` 'unsupported', required - `title` string, required - `description` string - `color` string, nullable - `reason` string, required - `width` integer - `height` integer - `id` string, required - `layout` object - `row` integer, required - `column` integer, required - `date_range` object, nullable - `start_ds` string, nullable - `end_ds` string, nullable - `start_offset_days` number, nullable - `end_offset_days` number, nullable - `widget_type` string, required - `query_type` string - `chart_type` string - object - `width` integer - `height` integer - `id` string - `description` string - `color` string, nullable - `layout` object - `row` integer, required - `column` integer, required - `date_range` object, nullable - `start_ds` string, nullable - `end_ds` string, nullable - `start_offset_days` number, nullable - `end_offset_days` number, nullable - `type` 'text' | 'header' | 'timeseries' | 'drilldown' | 'funnel' | 'unsupported' - `title` string - `content` string - `query` union: Replace the complete query. Arrays replace existing arrays rather than merging by position. - DashboardSharedSchema8 - `source` DashboardSharedSchema14 - `type` 'event', required - `event_name` string, required - `filters` object[] - … - `sources` DashboardSharedSchema14[] - `type` 'event', required - `event_name` string, required - `filters` object[] - … - `aggregation` object, required - `type` unknown, required - `property` object - … - `unit_type` string - `group_bys` DashboardSharedSchema7[] - `key` string, required - `column` string, required: Property namespace, such as `user_object` or `metric_source_metadata`. - `metric_source_column` string - `source` object, nullable - … - `viz` object - `chart_type` 'line' | 'timeseries-bar' | 'horizontal-bar' | 'grouped-bar' | 'pie' | 'geo-map' | 'samples' | 'stacked-line' | 'single-value' | 'conversion-rate' | 'conversions' | 'table', required - `date` union - … - `time_range` object - … - `granularity` 'month' | 'week' | 'day' | 'hour' | '5m' | '30m' | '1m' | 'auto' - `time_comparison` number - `time_comparison_hours` number - `rollup_type` 'none' | 'avg' | 'sum' | 'cumulative_sum' - `rollup_days` number - `y_axis_type` 'numbers' | 'monetary' | 'percentage' | 'time' | 'time_ns' | 'time_us' | 'time_ms' | 'decimal_bytes' | 'binary_bytes' | 'bits' | 'time_s' | 'percentage_ratio' - `cum_sum_rollup` 'unique' | 'all' - `single_value_type` 'latest' | 'overall' - `usage_interval_number_of_days` number - `show_delta_comparison_view` boolean - `is_time_comparison_last_period` boolean - `show_grouped_percentage_breakdown` boolean - `chart_view` 'chart' | 'legend' | 'chart_legend' - `show_percent_difference_compare_option` boolean - `use_widget_granularity_in_dashboard` boolean - `filters` object[] - `property` DashboardSharedSchema7, required - … - `operator` 'ANY_OF' | 'CONTAINS' | 'EQ' | 'GT' | 'LT' | 'GTE' | 'LTE' | 'IS_NOT_NULL' | 'IS_NULL' | 'NONE_OF' | 'NOT_CONTAINS' | 'SQL_FILTER' | 'STARTS_WITH' | 'ENDS_WITH' | 'AFTER_EXPOSURE' | 'BEFORE_EXPOSURE' | 'IS_TRUE' | 'IS_FALSE' | 'INCLUDED' | 'NOT_INCLUDED', required - `values` string[] - `label` string - `cohorts` union[] - union - … - `options` DashboardSharedSchema4 - `exposure_query_mode` 'all' | 'daily_first' | 'first' | 'fresh' - `group_by_limit` integer - `group_by_query_limit` integer - `separate_chart_per_metric` boolean - `force_start_y_at_zero` boolean - `include_annotations` boolean - `show_all_annotations` boolean - `annotation_filters` object - … - `sorting` object - … - `sampling_enabled` boolean - `include_test_events` boolean - `filter_bot_data` boolean - `enable_id_resolution` boolean - `is_precomputed_only` boolean - `default_id_type` string, nullable - `show_table_only` boolean - DashboardSharedSchema9 - `filters` object[] - `property` DashboardSharedSchema7, required - … - `operator` 'ANY_OF' | 'CONTAINS' | 'EQ' | 'GT' | 'LT' | 'GTE' | 'LTE' | 'IS_NOT_NULL' | 'IS_NULL' | 'NONE_OF' | 'NOT_CONTAINS' | 'SQL_FILTER' | 'STARTS_WITH' | 'ENDS_WITH' | 'AFTER_EXPOSURE' | 'BEFORE_EXPOSURE' | 'IS_TRUE' | 'IS_FALSE' | 'INCLUDED' | 'NOT_INCLUDED', required - `values` string[] - `label` string - `cohorts` union[] - union - … - `unit_type` string - `options` DashboardSharedSchema4 - `exposure_query_mode` 'all' | 'daily_first' | 'first' | 'fresh' - `group_by_limit` integer - `group_by_query_limit` integer - `separate_chart_per_metric` boolean - `force_start_y_at_zero` boolean - `include_annotations` boolean - `show_all_annotations` boolean - `annotation_filters` object - … - `sorting` object - … - `sampling_enabled` boolean - `include_test_events` boolean - `filter_bot_data` boolean - `enable_id_resolution` boolean - `is_precomputed_only` boolean - `default_id_type` string, nullable - `show_table_only` boolean - `series` DashboardSharedSchema2[], required - `id` string - `source` union, required - … - `definition` object - … - `unit_type` string - `filters` object[] - … - `group_bys` DashboardSharedSchema7[] - … - `alias` string - `hidden` boolean - `formulas` object[] - `id` string - `formula` string, required - `name` string - `hidden` boolean - `coalesce_nulls_as_zeroes` boolean - `highlight_as` 'error' | 'warning' - `group_bys` DashboardSharedSchema7[] - `key` string, required - `column` string, required: Property namespace, such as `user_object` or `metric_source_metadata`. - `metric_source_column` string - `source` object, nullable - … - `viz` object, required - `chart_type` 'line' | 'timeseries-bar' | 'horizontal-bar' | 'grouped-bar' | 'pie' | 'geo-map' | 'samples' | 'stacked-line' | 'single-value' | 'table', required - `date` union - … - `time_range` object - … - `granularity` 'month' | 'week' | 'day' | 'hour' | '5m' | '30m' | '1m' | 'auto' - `time_comparison` number - `time_comparison_hours` number - `rollup_type` 'none' | 'avg' | 'sum' | 'cumulative_sum' - `rollup_days` number - `y_axis_type` 'numbers' | 'monetary' | 'percentage' | 'time' | 'time_ns' | 'time_us' | 'time_ms' | 'decimal_bytes' | 'binary_bytes' | 'bits' | 'time_s' | 'percentage_ratio' - `cum_sum_rollup` 'unique' | 'all' - `single_value_type` 'latest' | 'overall' - `usage_interval_number_of_days` number - `show_delta_comparison_view` boolean - `is_time_comparison_last_period` boolean - `show_grouped_percentage_breakdown` boolean - `chart_view` 'chart' | 'legend' | 'chart_legend' - `show_percent_difference_compare_option` boolean - `use_widget_granularity_in_dashboard` boolean - DashboardSharedSchema6 - `filters` object[] - `property` DashboardSharedSchema7, required - … - `operator` 'ANY_OF' | 'CONTAINS' | 'EQ' | 'GT' | 'LT' | 'GTE' | 'LTE' | 'IS_NOT_NULL' | 'IS_NULL' | 'NONE_OF' | 'NOT_CONTAINS' | 'SQL_FILTER' | 'STARTS_WITH' | 'ENDS_WITH' | 'AFTER_EXPOSURE' | 'BEFORE_EXPOSURE' | 'IS_TRUE' | 'IS_FALSE' | 'INCLUDED' | 'NOT_INCLUDED', required - `values` string[] - `label` string - `cohorts` union[] - union - … - `unit_type` string - `options` DashboardSharedSchema4 - `exposure_query_mode` 'all' | 'daily_first' | 'first' | 'fresh' - `group_by_limit` integer - `group_by_query_limit` integer - `separate_chart_per_metric` boolean - `force_start_y_at_zero` boolean - `include_annotations` boolean - `show_all_annotations` boolean - `annotation_filters` object - … - `sorting` object - … - `sampling_enabled` boolean - `include_test_events` boolean - `filter_bot_data` boolean - `enable_id_resolution` boolean - `is_precomputed_only` boolean - `default_id_type` string, nullable - `show_table_only` boolean - `steps` union[], required - union - … - `conversion_window` object - `value` integer, required - `unit` 'second' | 'minute' | 'hour' | 'day', required - `chart_type` 'conversion-rate' | 'conversions' - `viz` object - `chart_type` 'line' | 'conversion-rate' | 'conversions', required - `date` union - … - `time_range` object - … - `granularity` 'month' | 'week' | 'day' | 'hour' | '5m' | '30m' | '1m' | 'auto' - `time_comparison` number - `time_comparison_hours` number - `rollup_type` 'none' | 'avg' | 'sum' | 'cumulative_sum' - `rollup_days` number - `y_axis_type` 'numbers' | 'monetary' | 'percentage' | 'time' | 'time_ns' | 'time_us' | 'time_ms' | 'decimal_bytes' | 'binary_bytes' | 'bits' | 'time_s' | 'percentage_ratio' - `cum_sum_rollup` 'unique' | 'all' - `single_value_type` 'latest' | 'overall' - `usage_interval_number_of_days` number - `show_delta_comparison_view` boolean - `is_time_comparison_last_period` boolean - `show_grouped_percentage_breakdown` boolean - `chart_view` 'chart' | 'legend' | 'chart_legend' - `show_percent_difference_compare_option` boolean - `use_widget_granularity_in_dashboard` boolean - `aggregation` 'daily' | 'overall' - `measurement` 'conversion_rate' | 'conversion_rate_over_time' | 'time_to_convert' - `is_sequential` boolean - `use_uniques_units` boolean - `group_bys` DashboardSharedSchema7[] - `key` string, required - `column` string, required: Property namespace, such as `user_object` or `metric_source_metadata`. - `metric_source_column` string - `source` object, nullable - … - `use_persistent_group_bys` boolean - `group_by_limit` integer - `sort_by_conversion_rate` boolean - `sort_order_is_descending` boolean - `time_to_convert_buckets` object - `range_min` number, required - `range_max` number, required - `interval_size` number, required - `bucket_units_min_max` 'second' | 'minute' | 'hour' | 'day', required - `bucket_units_bucket_size` 'second' | 'minute' | 'hour' | 'day', required - `time_to_convert_unit` 'second' | 'minute' | 'hour' | 'day' - `show_sum_property_value_last_step` boolean - `property_value_to_sum` string - `exclude_units_who_did_event` object - `events` object[], required - … - `between_steps` object - … ## Response `200` Updated widget identity and dashboard revision. - object - `message` string, required: A simple string explaining the result of the operation. - `data` object, required: A single result. - `id` string, required - `revision` string, required ## Other responses - `400`: Invalid request. Please check the request input and try again. - `404`: Not Found. The requested resource could not be found. - `412`: The revision changed. Read the dashboard again and reapply the edit. ## Changes - **2026-10-30** `a7f43412fb6b`: 1 info - endpoint added [Operation history](https://skmtc.dev/statsig/apis/console-api/changes/console/v1/dashboards/:id/widgets/:widgetId/patch.md) --- [API](https://skmtc.dev/statsig/apis/console-api.md) - [All operations](https://skmtc.dev/statsig/apis/console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/statsig/apis/console-api/revisions/605b784f2a7d?raw)