references/metric-configuration.md · 48000
ault": null,
"title": "Custom Name"
},
"data_warehouse_join_key": {
"title": "Data Warehouse Join Key",
"type": "string"
},
"events_join_key": {
"title": "Events Join Key",
"type": "string"
},
"fixedProperties": {
"anyOf": [
{
"items": {
"oneOf": [
{
"$ref": "#/$defs/EventPropertyFilter"
},
{
"$ref": "#/$defs/PersonPropertyFilter"
},
{
"$ref": "#/$defs/PersonMetadataPropertyFilter"
},
{
"$ref": "#/$defs/ElementPropertyFilter"
},
{
"$ref": "#/$defs/EventMetadataPropertyFilter"
},
{
"$ref": "#/$defs/SessionPropertyFilter"
},
{
"$ref": "#/$defs/CohortPropertyFilter"
},
{
"$ref": "#/$defs/RecordingPropertyFilter"
},
{
"$ref": "#/$defs/LogEntryPropertyFilter"
},
{
"$ref": "#/$defs/GroupPropertyFilter"
},
{
"$ref": "#/$defs/FeaturePropertyFilter"
},
{
"$ref": "#/$defs/FlagPropertyFilter"
},
{
"$ref": "#/$defs/HogQLPropertyFilter"
},
{
"$ref": "#/$defs/EmptyPropertyFilter"
},
{
"$ref": "#/$defs/DataWarehousePropertyFilter"
},
{
"$ref": "#/$defs/DataWarehousePersonPropertyFilter"
},
{
"$ref": "#/$defs/ErrorTrackingIssueFilter"
},
{
"$ref": "#/$defs/LogPropertyFilter"
},
{
"$ref": "#/$defs/MetricPropertyFilter"
},
{
"$ref": "#/$defs/SpanPropertyFilter"
},
{
"$ref": "#/$defs/RevenueAnalyticsPropertyFilter"
},
{
"$ref": "#/$defs/AccountCustomPropertyFilter"
},
{
"$ref": "#/$defs/WorkflowVariablePropertyFilter"
},
{
"$ref": "#/$defs/BehavioralPropertyFilter"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person)",
"title": "Fixedproperties"
},
"kind": {
"const": "ExperimentDataWarehouseNode",
"default": "ExperimentDataWarehouseNode",
"title": "Kind",
"type": "string"
},
"math": {
"anyOf": [
{
"$ref": "#/$defs/BaseMathType"
},
{
"$ref": "#/$defs/FunnelMathType"
},
{
"$ref": "#/$defs/PropertyMathType"
},
{
"$ref": "#/$defs/CountPerActorMathType"
},
{
"$ref": "#/$defs/GroupMathType"
},
{
"$ref": "#/$defs/ExperimentMetricMathType"
},
{
"$ref": "#/$defs/CalendarHeatmapMathType"
},
{
"const": "hogql",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Math"
},
"math_group_type_index": {
"anyOf": [
{
"$ref": "#/$defs/MathGroupTypeIndex"
},
{
"type": "null"
}
],
"default": null
},
"math_hogql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Math Hogql"
},
"math_multiplier": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Math Multiplier"
},
"math_property": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Math Property"
},
"math_property_revenue_currency": {
"anyOf": [
{
"$ref": "#/$defs/RevenueCurrencyPropertyConfig"
},
{
"type": "null"
}
],
"default": null
},
"math_property_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Math Property Type"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"optionalInFunnel": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Optionalinfunnel"
},
"properties": {
"anyOf": [
{
"items": {
"oneOf": [
{
"$ref": "#/$defs/EventPropertyFilter"
},
{
"$ref": "#/$defs/PersonPropertyFilter"
},
{
"$ref": "#/$defs/PersonMetadataPropertyFilter"
},
{
"$ref": "#/$defs/ElementPropertyFilter"
},
{
"$ref": "#/$defs/EventMetadataPropertyFilter"
},
{
"$ref": "#/$defs/SessionPropertyFilter"
},
{
"$ref": "#/$defs/CohortPropertyFilter"
},
{
"$ref": "#/$defs/RecordingPropertyFilter"
},
{
"$ref": "#/$defs/LogEntryPropertyFilter"
},
{
"$ref": "#/$defs/GroupPropertyFilter"
},
{
"$ref": "#/$defs/FeaturePropertyFilter"
},
{
"$ref": "#/$defs/FlagPropertyFilter"
},
{
"$ref": "#/$defs/HogQLPropertyFilter"
},
{
"$ref": "#/$defs/EmptyPropertyFilter"
},
{
"$ref": "#/$defs/DataWarehousePropertyFilter"
},
{
"$ref": "#/$defs/DataWarehousePersonPropertyFilter"
},
{
"$ref": "#/$defs/ErrorTrackingIssueFilter"
},
{
"$ref": "#/$defs/LogPropertyFilter"
},
{
"$ref": "#/$defs/MetricPropertyFilter"
},
{
"$ref": "#/$defs/SpanPropertyFilter"
},
{
"$ref": "#/$defs/RevenueAnalyticsPropertyFilter"
},
{
"$ref": "#/$defs/AccountCustomPropertyFilter"
},
{
"$ref": "#/$defs/WorkflowVariablePropertyFilter"
},
{
"$ref": "#/$defs/BehavioralPropertyFilter"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Properties configurable in the interface",
"title": "Properties"
},
"response": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Response"
},
"table_name": {
"title": "Table Name",
"type": "string"
},
"timestamp_field": {
"title": "Timestamp Field",
"type": "string"
},
"version": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "version of the node, used for schema migrations",
"title": "Version"
}
},
"required": [
"data_warehouse_join_key",
"events_join_key",
"table_name",
"timestamp_field"
],
"title": "ExperimentDataWarehouseNode",
"type": "object"
},
"ExperimentExposureNode": {
"additionalProperties": false,
"properties": {
"kind": {
"const": "ExperimentExposureNode",
"default": "ExperimentExposureNode",
"title": "Kind",
"type": "string"
},
"response": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Response"
},
"version": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "version of the node, used for schema migrations",
"title": "Version"
}
},
"title": "ExperimentExposureNode",
"type": "object"
},
"ExperimentFunnelMetric": {
"additionalProperties": false,
"properties": {
"breakdownAttributionType": {
"anyOf": [
{
"$ref": "#/$defs/BreakdownAttributionType"
},
{
"type": "null"
}
],
"default": "first_touch",
"description": "How to attribute the breakdown value across funnel steps."
},
"breakdownAttributionValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "When breakdownAttributionType is step, the 0-indexed step to attribute from.",
"title": "Breakdownattributionvalue"
},
"breakdownFilter": {
"anyOf": [
{
"$ref": "#/$defs/BreakdownFilter"
},
{
"type": "null"
}
],
"default": null
},
"conversion_window": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Conversion Window"
},
"conversion_window_unit": {
"anyOf": [
{
"$ref": "#/$defs/FunnelConversionWindowTimeUnit"
},
{
"type": "null"
}
],
"default": null
},
"fingerprint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Fingerprint"
},
"funnel_order_type": {
"anyOf": [
{
"$ref": "#/$defs/StepOrderValue"
},
{
"type": "null"
}
],
"default": null
},
"goal": {
"anyOf": [
{
"$ref": "#/$defs/ExperimentMetricGoal"
},
{
"type": "null"
}
],
"default": null
},
"isSharedMetric": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Issharedmetric"
},
"kind": {
"const": "ExperimentMetric",
"default": "ExperimentMetric",
"title": "Kind",
"type": "string"
},
"metric_type": {
"const": "funnel",
"default": "funnel",
"title": "Metric Type",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"response": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Response"
},
"series": {
"items": {
"discriminator": {
"mapping": {
"ActionsNode": "#/$defs/ActionsNode",
"EventsNode": "#/$defs/EventsNode",
"ExperimentDataWarehouseNode": "#/$defs/ExperimentDataWarehouseNode"
},
"propertyName": "kind"
},
"oneOf": [
{
"$ref": "#/$defs/EventsNode"
},
{
"$ref": "#/$defs/ActionsNode"
},
{
"$ref": "#/$defs/ExperimentDataWarehouseNode"
}
]
},
"title": "Series",
"type": "array"
},
"sharedMetricId": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Sharedmetricid"
},
"uuid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uuid"
},
"version": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "version of the node, used for schema migrations",
"title": "Version"
}
},
"required": [
"series"
],
"title": "ExperimentFunnelMetric",
"type": "object"
},
"ExperimentMeanMetric": {
"additionalProperties": false,
"properties": {
"breakdownFilter": {
"anyOf": [
{
"$ref": "#/$defs/BreakdownFilter"
},
{
"type": "null"
}
],
"default": null
},
"conversion_window": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Conversion Window"
},
"conversion_window_unit": {
"anyOf": [
{
"$ref": "#/$defs/FunnelConversionWindowTimeUnit"
},
{
"type": "null"
}
],
"default": null
},
"fingerprint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Fingerprint"
},
"goal": {
"anyOf": [
{
"$ref": "#/$defs/ExperimentMetricGoal"
},
{
"type": "null"
}
],
"default": null
},
"ignore_zeros": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Ignore Zeros"
},
"isSharedMetric": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Issharedmetric"
},
"kind": {
"const": "ExperimentMetric",
"default": "ExperimentMetric",
"title": "Kind",
"type": "string"
},
"lower_bound_percentile": {
"anyOf": [
{
"maximum": 1.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Winsorization lower percentile bound, as a fraction in [0, 1] (e.g. 0.01 for the 1st percentile).",
"title": "Lower Bound Percentile"
},
"metric_type": {
"const": "mean",
"default": "mean",
"title": "Metric Type",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"response": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Response"
},
"sharedMetricId": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Sharedmetricid"
},
"source": {
"discriminator": {
"mapping": {
"ActionsNode": "#/$defs/ActionsNode",
"EventsNode": "#/$defs/EventsNode",
"ExperimentDataWarehouseNode": "#/$defs/ExperimentDataWarehouseNode",
"ExperimentWarehouseNativeNode": "#/$defs/ExperimentWarehouseNativeNode"
},
"propertyName": "kind"
},
"oneOf": [
{
"$ref": "#/$defs/EventsNode"
},
{
"$ref": "#/$defs/ActionsNode"
},
{
"$ref": "#/$defs/ExperimentDataWarehouseNode"
},
{
"$ref": "#/$defs/ExperimentWarehouseNativeNode"
}
],
"title": "Source"
},
"threshold": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "When set, reports the percentage of users whose per-user summed/counted value reaches or exceeds this threshold. Only meaningful for sum/count math types.",
"title": "Threshold"
},
"upper_bound_percentile": {
"anyOf": [
{
"maximum": 1.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Winsorization upper percentile bound, as a fraction in [0, 1] (e.g. 0.99 for the 99th percentile).",
"title": "Upper Bound Percentile"
},
"uuid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Uuid"
},
"version": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "version of the node, used for schema migrations",
"title": "Version"
}
},
"required": [
"source"
],
"title": "ExperimentMeanMetric",
"type": "object"
},
"ExperimentMetricGoal": {
"enum": [
"increase",
"decrease"
],
"title": "ExperimentMetricGoal",
"type": "string"
},
"ExperimentMetricMathType": {
"enum": [
"total",
"sum",
"unique_session",
"min",
"max",
"avg",
"dau",
"unique_group",
"hogql"
],
"title": "ExperimentMetricMathType",
"type": "string"
},
"ExperimentMetricOutlierHandling": {
"additionalProperties": false,
"properties": {
"ignore_zeros": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Ignore Zeros"
},
"lower_bound_percentile": {
"anyOf": [
{
"maximum": 1.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Winsorization lower percentile bound, as a fraction in [0, 1] (e.g. 0.01 for the 1st percentile).",
"title": "Lower Bound Percentile"
},
"upper_bound_percentile": {
"anyOf": [
{
"maximum": 1.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Winsorization upper percentile bound, as a fraction in [0, 1] (e.g. 0.99 for the 99th percentile).",
"title": "Upper Bound Percentile"
}
},
"title": "ExperimentMetricOutlierHandling",
"type": "object"
},
"ExperimentRatioMetric": {
"additionalProperties": false,
"properties": {
"breakdownFilter": {
"anyOf": [
{
"$ref": "#/$defs/BreakdownFilter"
},
{
"type": "null"
}
],
"default": null
},
"conversion_window": {
"anyOf": [
{