PostHog · Schema
FunnelsFilter
A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording
Properties
| Name | Type | Description |
|---|---|---|
| binCount | integer | |
| breakdownAttributionType | object | |
| breakdownAttributionValue | integer | |
| breakdownSorting | string | Breakdown table sorting. Format: 'column_key' or '-column_key' (descending) |
| customAggregationTarget | boolean | For data warehouse based funnel insights when the aggregation target can't be mapped to persons or groups. |
| exclusions | array | |
| funnelAggregateByHogQL | string | |
| funnelFromStep | integer | |
| funnelOrderType | object | |
| funnelStepReference | object | |
| funnelToStep | integer | To select the range of steps for trends & time to convert funnels, 0-indexed |
| funnelVizType | object | |
| funnelWindowInterval | integer | |
| funnelWindowIntervalUnit | object | |
| goalLines | array | Goal Lines |
| hiddenLegendBreakdowns | array | |
| layout | object | |
| resultCustomizations | object | Customizations for the appearance of result datasets. |
| showTrendLines | boolean | Display linear regression trend lines on the chart (only for historical trends viz) |
| showValuesOnSeries | boolean | |
| useUdf | boolean |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/FunnelsFilter",
"title": "FunnelsFilter",
"additionalProperties": false,
"properties": {
"binCount": {
"default": null,
"title": "Bincount",
"type": "integer",
"nullable": true
},
"breakdownAttributionType": {
"default": "first_touch",
"allOf": [
{
"$ref": "#/components/schemas/BreakdownAttributionType"
}
],
"nullable": true
},
"breakdownAttributionValue": {
"default": null,
"title": "Breakdownattributionvalue",
"type": "integer",
"nullable": true
},
"breakdownSorting": {
"default": null,
"description": "Breakdown table sorting. Format: 'column_key' or '-column_key' (descending)",
"title": "Breakdownsorting",
"type": "string",
"nullable": true
},
"customAggregationTarget": {
"default": null,
"description": "For data warehouse based funnel insights when the aggregation target can't be mapped to persons or groups.",
"title": "Customaggregationtarget",
"type": "boolean",
"nullable": true
},
"exclusions": {
"default": [],
"title": "Exclusions",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/FunnelExclusionEventsNode"
},
{
"$ref": "#/components/schemas/FunnelExclusionActionsNode"
}
]
},
"type": "array",
"nullable": true
},
"funnelAggregateByHogQL": {
"default": null,
"title": "Funnelaggregatebyhogql",
"type": "string",
"nullable": true
},
"funnelFromStep": {
"default": null,
"title": "Funnelfromstep",
"type": "integer",
"nullable": true
},
"funnelOrderType": {
"default": "ordered",
"allOf": [
{
"$ref": "#/components/schemas/StepOrderValue"
}
],
"nullable": true
},
"funnelStepReference": {
"default": "total",
"allOf": [
{
"$ref": "#/components/schemas/FunnelStepReference"
}
],
"nullable": true
},
"funnelToStep": {
"default": null,
"description": "To select the range of steps for trends & time to convert funnels, 0-indexed",
"title": "Funneltostep",
"type": "integer",
"nullable": true
},
"funnelVizType": {
"default": "steps",
"allOf": [
{
"$ref": "#/components/schemas/FunnelVizType"
}
],
"nullable": true
},
"funnelWindowInterval": {
"default": 14,
"title": "Funnelwindowinterval",
"type": "integer",
"nullable": true
},
"funnelWindowIntervalUnit": {
"default": "day",
"allOf": [
{
"$ref": "#/components/schemas/FunnelConversionWindowTimeUnit"
}
],
"nullable": true
},
"goalLines": {
"default": null,
"description": "Goal Lines",
"title": "Goallines",
"items": {
"$ref": "#/components/schemas/GoalLine"
},
"type": "array",
"nullable": true
},
"hiddenLegendBreakdowns": {
"default": null,
"title": "Hiddenlegendbreakdowns",
"items": {
"type": "string"
},
"type": "array",
"nullable": true
},
"layout": {
"default": "vertical",
"allOf": [
{
"$ref": "#/components/schemas/FunnelLayout"
}
],
"nullable": true
},
"resultCustomizations": {
"default": null,
"description": "Customizations for the appearance of result datasets.",
"title": "Resultcustomizations",
"additionalProperties": {
"$ref": "#/components/schemas/ResultCustomizationByValue"
},
"type": "object",
"nullable": true
},
"showTrendLines": {
"default": null,
"description": "Display linear regression trend lines on the chart (only for historical trends viz)",
"title": "Showtrendlines",
"type": "boolean",
"nullable": true
},
"showValuesOnSeries": {
"default": false,
"title": "Showvaluesonseries",
"type": "boolean",
"nullable": true
},
"useUdf": {
"default": null,
"title": "Useudf",
"type": "boolean",
"nullable": true
}
},
"type": "object"
}