For AI agents: a documentation index is available at /llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.
Update Dashboard Widget
Edit one widget using a full supported definition or sparse metadata/layout/query patch and the dashboard revision. Query and arrays replace their complete p…
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.
patch
https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}Authorizations
STATSIG-API-KEYstringrequiredapiKey (header)
Path parameters
idstringrequireddashboard id
widgetIdstringrequiredwidget id
Body
application/jsonrevisionstringrequiredInclude the revision returned by an editable or references read. Read the dashboard again after a revision conflict.
widgetoneOfrequiredConstraints:
oneOf (oneOf (object, object, object, object, object), object)objectShow child attributes
widthintegerConstraints:
min: 0max: 12heightintegerConstraints:
min: 0idstringdescriptionstringcolorstringConstraints:
nullablelayoutobjectrowintegerrequiredConstraints:
min: 0columnintegerrequiredConstraints:
min: 0max: 11date_rangeobjectConstraints:
nullablestart_dsstringConstraints:
nullableend_dsstringConstraints:
nullablestart_offset_daysnumberConstraints:
nullableend_offset_daysnumberConstraints:
nullabletypestringAllowed values:
textheadertimeseriesdrilldownfunnelunsupportedtitlestringcontentstringqueryoneOfReplace the complete query. Arrays replace existing arrays rather than merging by position.
Constraints:
objectobjectobjectsourceobjecttypestringrequiredAllowed values:
eventevent_namestringrequiredfiltersobject[]propertyobjectrequiredkeystringrequiredcolumnunknownrequiredoperatorunknownrequiredvaluesstring[]Default:
[]sourcesobject[]typestringrequiredAllowed values:
eventevent_namestringrequiredfiltersobject[]propertyobjectrequiredkeystringrequiredcolumnunknownrequiredoperatorunknownrequiredvaluesstring[]Default:
[]aggregationobject or stringAllowed values:
dailyoveralltypeunknownrequiredpropertyobjectkeystringrequiredcolumnunknownrequiredunit_typestringgroup_bysobject[]keystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullablevizobjectchart_typestringrequiredAllowed values:
linetimeseries-barhorizontal-bargrouped-barpiegeo-mapsamplesstacked-linesingle-valueconversion-rateconversionstabledateoneOfConstraints:
objectobjecttypestringrequiredAllowed values:
relativefixedwindow_sizenumberoffset_daysnumberlabelstringrequiredstart_msnumberend_msnumberexcluded_dates_msnumber[]is_relative_to_nowbooleanWhen true, the Console uses a recognized relative label to refresh the saved date bounds when it loads the chart.
time_rangeobjectstart_msnumberrequiredend_msnumberrequiredlabelstringrequiredis_relative_to_nowbooleangranularitystringAllowed values:
monthweekdayhour5m30m1mautotime_comparisonnumbertime_comparison_hoursnumberrollup_typestringAllowed values:
noneavgsumcumulative_sumrollup_daysnumbery_axis_typestringAllowed values:
numbersmonetarypercentagetimetime_nstime_ustime_msdecimal_bytesbinary_bytesbitstime_spercentage_ratiocum_sum_rollupstringAllowed values:
uniqueallsingle_value_typestringAllowed values:
latestoverallusage_interval_number_of_daysnumbershow_delta_comparison_viewbooleanis_time_comparison_last_periodbooleanshow_grouped_percentage_breakdownbooleanchart_viewstringAllowed values:
chartlegendchart_legendshow_percent_difference_compare_optionbooleanuse_widget_granularity_in_dashboardbooleanfiltersobject[]propertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringcohortsoneOf[]idstringConstraints:
min length: 1namestringunit_typestringeventsobject[]eventobjectrequiredevent_namestringrequiredfiltersobject[]requiredpropertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringaliasstringis_first_timebooleanmetric_typestringmetric_source_idstringevent_name_columnstringConstraints:
nullableanalytics_configstringAllowed values:
fact_tablesingle_eventmulti_eventoperatorstringrequiredAllowed values:
><>=<==thresholdnumberrequireddate_rangeoneOfrequiredConstraints:
objectobjecttypestringrequiredAllowed values:
relativefixedwindow_sizenumberoffset_daysnumberlabelstringrequiredstart_msnumberend_msnumberexcluded_dates_msnumber[]is_relative_to_nowbooleanWhen true, the Console uses a recognized relative label to refresh the saved date bounds when it loads the chart.
any_eventbooleanis_verifiedbooleanoptionsobjectexposure_query_modestringAllowed values:
alldaily_firstfirstfreshgroup_by_limitintegerConstraints:
min: 0group_by_query_limitintegerConstraints:
min: 0separate_chart_per_metricbooleanforce_start_y_at_zerobooleaninclude_annotationsbooleanshow_all_annotationsbooleanannotation_filtersobjectfilter_entity_typestring[]filter_tagobjectidsstring[]operatorstringfilter_target_appstring[]filter_environmentstring[]filter_teamstring[]filter_creatorstring[]filter_gate_namestring[]filter_dynamic_config_namestring[]filter_experiment_namestring[]sortingobjectmetric_metadataobjectnamestringrequiredtypestringrequiredAllowed values:
COUNTCOUNT_DISTINCTCOUNT_DISTINCT_VALUECOUNT_DISTINCT_VALUE_PER_USERAVG_COUNT_PER_USERMAX_COUNT_PER_USERMIN_COUNT_PER_USERP50_COUNT_PER_USERP75_COUNT_PER_USERP90_COUNT_PER_USERP95_COUNT_PER_USERP99_COUNT_PER_USERSUMAVGCONVERSION_RATEFUNNELP50P75P90P95P99MAXMINOTEL_COUNTER__SUMOTEL_COUNTER__AVGOTEL_COUNTER__MINOTEL_COUNTER__MAXOTEL_HISTOGRAM__COUNTOTEL_HISTOGRAM__SUMOTEL_HISTOGRAM__AVGOTEL_HISTOGRAM__P50OTEL_HISTOGRAM__P75OTEL_HISTOGRAM__P90OTEL_HISTOGRAM__P95OTEL_HISTOGRAM__P99OTEL_GAUGE__AVGOTEL_GAUGE__SUMOTEL_GAUGE__MINOTEL_GAUGE__MAXpropertyobjectkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullablemetric_symbolstringsort_ascendingbooleansampling_enabledbooleaninclude_test_eventsbooleanfilter_bot_databooleanenable_id_resolutionbooleanis_precomputed_onlybooleandefault_id_typestringConstraints:
nullableshow_table_onlybooleanseriesobject[]idstringsourceoneOfrequiredConstraints:
objectobjectobjectobjectobjecttypestringrequiredAllowed values:
eventmetricmetric_sourceexposuretable_configevent_namestringmetric_idstringConstraints:
pattern: ^.+::[^:]+$metric_source_idstringConstraints:
min length: 1kindstringAllowed values:
experimentgateconfiglayernamestringtable_config_idstringConstraints:
min length: 1definitionobjecteventsobject[]requiredevent_namestringrequiredfiltersobject[]requiredpropertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringaliasstringis_first_timebooleanmetric_typestringmetric_source_idstringevent_name_columnstringConstraints:
nullableanalytics_configstringAllowed values:
fact_tablesingle_eventmulti_eventaggregationobjectrequiredtypestringrequiredAllowed values:
COUNTCOUNT_DISTINCTCOUNT_DISTINCT_VALUECOUNT_DISTINCT_VALUE_PER_USERAVG_COUNT_PER_USERMAX_COUNT_PER_USERMIN_COUNT_PER_USERP50_COUNT_PER_USERP75_COUNT_PER_USERP90_COUNT_PER_USERP95_COUNT_PER_USERP99_COUNT_PER_USERSUMAVGCONVERSION_RATEFUNNELP50P75P90P95P99MAXMINOTEL_COUNTER__SUMOTEL_COUNTER__AVGOTEL_COUNTER__MINOTEL_COUNTER__MAXOTEL_HISTOGRAM__COUNTOTEL_HISTOGRAM__SUMOTEL_HISTOGRAM__AVGOTEL_HISTOGRAM__P50OTEL_HISTOGRAM__P75OTEL_HISTOGRAM__P90OTEL_HISTOGRAM__P95OTEL_HISTOGRAM__P99OTEL_GAUGE__AVGOTEL_GAUGE__SUMOTEL_GAUGE__MINOTEL_GAUGE__MAXpropertyobjectkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableuniques_windowstringAllowed values:
dailyweeklymonthlydefaultcompositeobjecttypestringrequiredAllowed values:
rationumeratorobjectrequiredeventsobject[]requiredevent_namestringrequiredfiltersobject[]requiredpropertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringaliasstringis_first_timebooleanmetric_typestringmetric_source_idstringevent_name_columnstringConstraints:
nullableanalytics_configstringAllowed values:
fact_tablesingle_eventmulti_eventaggregationobjectrequiredtypestringrequiredAllowed values:
COUNTCOUNT_DISTINCTCOUNT_DISTINCT_VALUECOUNT_DISTINCT_VALUE_PER_USERAVG_COUNT_PER_USERMAX_COUNT_PER_USERMIN_COUNT_PER_USERP50_COUNT_PER_USERP75_COUNT_PER_USERP90_COUNT_PER_USERP95_COUNT_PER_USERP99_COUNT_PER_USERSUMAVGCONVERSION_RATEFUNNELP50P75P90P95P99MAXMINOTEL_COUNTER__SUMOTEL_COUNTER__AVGOTEL_COUNTER__MINOTEL_COUNTER__MAXOTEL_HISTOGRAM__COUNTOTEL_HISTOGRAM__SUMOTEL_HISTOGRAM__AVGOTEL_HISTOGRAM__P50OTEL_HISTOGRAM__P75OTEL_HISTOGRAM__P90OTEL_HISTOGRAM__P95OTEL_HISTOGRAM__P99OTEL_GAUGE__AVGOTEL_GAUGE__SUMOTEL_GAUGE__MINOTEL_GAUGE__MAXpropertyobjectkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableuniques_windowstringAllowed values:
dailyweeklymonthlydefaultdenominatorobjectrequiredeventsobject[]requiredevent_namestringrequiredfiltersobject[]requiredpropertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringaliasstringis_first_timebooleanmetric_typestringmetric_source_idstringevent_name_columnstringConstraints:
nullableanalytics_configstringAllowed values:
fact_tablesingle_eventmulti_eventaggregationobjectrequiredtypestringrequiredAllowed values:
COUNTCOUNT_DISTINCTCOUNT_DISTINCT_VALUECOUNT_DISTINCT_VALUE_PER_USERAVG_COUNT_PER_USERMAX_COUNT_PER_USERMIN_COUNT_PER_USERP50_COUNT_PER_USERP75_COUNT_PER_USERP90_COUNT_PER_USERP95_COUNT_PER_USERP99_COUNT_PER_USERSUMAVGCONVERSION_RATEFUNNELP50P75P90P95P99MAXMINOTEL_COUNTER__SUMOTEL_COUNTER__AVGOTEL_COUNTER__MINOTEL_COUNTER__MAXOTEL_HISTOGRAM__COUNTOTEL_HISTOGRAM__SUMOTEL_HISTOGRAM__AVGOTEL_HISTOGRAM__P50OTEL_HISTOGRAM__P75OTEL_HISTOGRAM__P90OTEL_HISTOGRAM__P95OTEL_HISTOGRAM__P99OTEL_GAUGE__AVGOTEL_GAUGE__SUMOTEL_GAUGE__MINOTEL_GAUGE__MAXpropertyobjectkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableuniques_windowstringAllowed values:
dailyweeklymonthlydefaultnull_handlingstringAllowed values:
skiptreat_as_zerounit_typestringfiltersobject[]propertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringgroup_bysobject[]keystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullablealiasstringhiddenbooleanformulasobject[]idstringformulastringrequirednamestringhiddenbooleancoalesce_nulls_as_zeroesbooleanhighlight_asstringAllowed values:
errorwarningstepsoneOf[]event_namestringfiltersobject[]propertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringeventsobject[]event_namestringrequiredfiltersobject[]requiredpropertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringaliasstringis_first_timebooleanmetric_typestringmetric_source_idstringevent_name_columnstringConstraints:
nullableanalytics_configstringAllowed values:
fact_tablesingle_eventmulti_eventmetricobjectidstringsourceoneOfrequiredConstraints:
objectobjectobjectobjectobjecttypestringrequiredAllowed values:
eventmetricmetric_sourceexposuretable_configevent_namestringmetric_idstringConstraints:
pattern: ^.+::[^:]+$metric_source_idstringConstraints:
min length: 1kindstringAllowed values:
experimentgateconfiglayernamestringtable_config_idstringConstraints:
min length: 1definitionobjecteventsobject[]requiredevent_namestringrequiredfiltersobject[]requiredpropertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringaliasstringis_first_timebooleanmetric_typestringmetric_source_idstringevent_name_columnstringConstraints:
nullableanalytics_configstringAllowed values:
fact_tablesingle_eventmulti_eventaggregationobjectrequiredtypestringrequiredAllowed values:
COUNTCOUNT_DISTINCTCOUNT_DISTINCT_VALUECOUNT_DISTINCT_VALUE_PER_USERAVG_COUNT_PER_USERMAX_COUNT_PER_USERMIN_COUNT_PER_USERP50_COUNT_PER_USERP75_COUNT_PER_USERP90_COUNT_PER_USERP95_COUNT_PER_USERP99_COUNT_PER_USERSUMAVGCONVERSION_RATEFUNNELP50P75P90P95P99MAXMINOTEL_COUNTER__SUMOTEL_COUNTER__AVGOTEL_COUNTER__MINOTEL_COUNTER__MAXOTEL_HISTOGRAM__COUNTOTEL_HISTOGRAM__SUMOTEL_HISTOGRAM__AVGOTEL_HISTOGRAM__P50OTEL_HISTOGRAM__P75OTEL_HISTOGRAM__P90OTEL_HISTOGRAM__P95OTEL_HISTOGRAM__P99OTEL_GAUGE__AVGOTEL_GAUGE__SUMOTEL_GAUGE__MINOTEL_GAUGE__MAXpropertyobjectkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableuniques_windowstringAllowed values:
dailyweeklymonthlydefaultcompositeobjecttypestringrequiredAllowed values:
rationumeratorobjectrequiredeventsobject[]requiredevent_namestringrequiredfiltersobject[]requiredpropertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringaliasstringis_first_timebooleanmetric_typestringmetric_source_idstringevent_name_columnstringConstraints:
nullableanalytics_configstringAllowed values:
fact_tablesingle_eventmulti_eventaggregationobjectrequiredtypestringrequiredAllowed values:
COUNTCOUNT_DISTINCTCOUNT_DISTINCT_VALUECOUNT_DISTINCT_VALUE_PER_USERAVG_COUNT_PER_USERMAX_COUNT_PER_USERMIN_COUNT_PER_USERP50_COUNT_PER_USERP75_COUNT_PER_USERP90_COUNT_PER_USERP95_COUNT_PER_USERP99_COUNT_PER_USERSUMAVGCONVERSION_RATEFUNNELP50P75P90P95P99MAXMINOTEL_COUNTER__SUMOTEL_COUNTER__AVGOTEL_COUNTER__MINOTEL_COUNTER__MAXOTEL_HISTOGRAM__COUNTOTEL_HISTOGRAM__SUMOTEL_HISTOGRAM__AVGOTEL_HISTOGRAM__P50OTEL_HISTOGRAM__P75OTEL_HISTOGRAM__P90OTEL_HISTOGRAM__P95OTEL_HISTOGRAM__P99OTEL_GAUGE__AVGOTEL_GAUGE__SUMOTEL_GAUGE__MINOTEL_GAUGE__MAXpropertyobjectkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableuniques_windowstringAllowed values:
dailyweeklymonthlydefaultdenominatorobjectrequiredeventsobject[]requiredevent_namestringrequiredfiltersobject[]requiredpropertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringaliasstringis_first_timebooleanmetric_typestringmetric_source_idstringevent_name_columnstringConstraints:
nullableanalytics_configstringAllowed values:
fact_tablesingle_eventmulti_eventaggregationobjectrequiredtypestringrequiredAllowed values:
COUNTCOUNT_DISTINCTCOUNT_DISTINCT_VALUECOUNT_DISTINCT_VALUE_PER_USERAVG_COUNT_PER_USERMAX_COUNT_PER_USERMIN_COUNT_PER_USERP50_COUNT_PER_USERP75_COUNT_PER_USERP90_COUNT_PER_USERP95_COUNT_PER_USERP99_COUNT_PER_USERSUMAVGCONVERSION_RATEFUNNELP50P75P90P95P99MAXMINOTEL_COUNTER__SUMOTEL_COUNTER__AVGOTEL_COUNTER__MINOTEL_COUNTER__MAXOTEL_HISTOGRAM__COUNTOTEL_HISTOGRAM__SUMOTEL_HISTOGRAM__AVGOTEL_HISTOGRAM__P50OTEL_HISTOGRAM__P75OTEL_HISTOGRAM__P90OTEL_HISTOGRAM__P95OTEL_HISTOGRAM__P99OTEL_GAUGE__AVGOTEL_GAUGE__SUMOTEL_GAUGE__MINOTEL_GAUGE__MAXpropertyobjectkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableuniques_windowstringAllowed values:
dailyweeklymonthlydefaultnull_handlingstringAllowed values:
skiptreat_as_zerounit_typestringfiltersobject[]propertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringgroup_bysobject[]keystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullablealiasstringhiddenbooleanaliasstringis_metric_expandedbooleanis_optionalbooleanshould_compare_eventsbooleanconversion_windowobjectvalueintegerrequiredConstraints:
min: 0unitstringrequiredAllowed values:
secondminutehourdaychart_typestringAllowed values:
conversion-rateconversionsmeasurementstringAllowed values:
conversion_rateconversion_rate_over_timetime_to_convertis_sequentialbooleanuse_uniques_unitsbooleanuse_persistent_group_bysbooleangroup_by_limitintegerConstraints:
min: 0sort_by_conversion_ratebooleansort_order_is_descendingbooleantime_to_convert_bucketsobjectrange_minnumberrequiredrange_maxnumberrequiredinterval_sizenumberrequiredConstraints:
min: 0bucket_units_min_maxstringrequiredAllowed values:
secondminutehourdaybucket_units_bucket_sizestringrequiredAllowed values:
secondminutehourdaytime_to_convert_unitstringAllowed values:
secondminutehourdayshow_sum_property_value_last_stepbooleanproperty_value_to_sumstringexclude_units_who_did_eventobjecteventsobject[]requiredevent_namestringrequiredfiltersobject[]requiredpropertyobjectrequiredkeystringrequiredcolumnstringrequiredProperty namespace, such as user_object or metric_source_metadata.
metric_source_columnstringsourceobjectConstraints:
nullabletypestringrequiredAllowed values:
experimentechidna_entity_property_sourceexperiment_namestringrequiredrule_idstringConstraints:
nullableis_holdoutbooleanConstraints:
nullableoperatorstringrequiredAllowed values:
ANY_OFCONTAINSEQGTLTGTELTEIS_NOT_NULLIS_NULLNONE_OFNOT_CONTAINSSQL_FILTERSTARTS_WITHENDS_WITHAFTER_EXPOSUREBEFORE_EXPOSUREIS_TRUEIS_FALSEINCLUDEDNOT_INCLUDEDvaluesstring[]Default:
[]labelstringaliasstringis_first_timebooleanmetric_typestringmetric_source_idstringevent_name_columnstringConstraints:
nullableanalytics_configstringAllowed values:
fact_tablesingle_eventmulti_eventbetween_stepsobjectstartintegerrequiredConstraints:
min: 0endintegerrequiredConstraints:
min: 0Response
application/json200· Updated widget identity and dashboard revision.
messagestringrequiredA simple string explaining the result of the operation.
dataobjectrequiredShow child attributes
idstringrequiredrevisionstringrequired400· Invalid request. Please check the request input and try again.
statusintegerrequiredAllowed values:
400messagestringrequired404· Not Found. The requested resource could not be found.
statusintegerrequiredAllowed values:
404messagestringrequiredWas this helpful?