DashboardTemplateScopeEnum
{
"enum": [
"team",
"global",
"feature_flag"
],
"type": "string",
"description": "* `team` - Only team\n* `global` - Global\n* `feature_flag` - Feature Flag"
}
DashboardTileBasic
{
"type": "object",
"required": [
"dashboard_id",
"id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"deleted": {
"type": "boolean",
"nullable": true
},
"dashboard_id": {
"type": "integer",
"readOnly": true
}
}
}
DashboardsListCollaboratorsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
}
DashboardsSharingListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
DataTableNode
{
"type": "object",
"title": "DataTableNode",
"required": [
"source"
],
"properties": {
"full": {
"type": "boolean",
"title": "Full",
"default": null,
"nullable": true,
"description": "Show with most visual options enabled. Used in scenes."
},
"kind": {
"const": "DataTableNode",
"title": "Kind",
"default": "DataTableNode"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/EventsQuery"
},
{
"$ref": "#/components/schemas/PersonsNode"
},
{
"$ref": "#/components/schemas/ActorsQuery"
},
{
"$ref": "#/components/schemas/HogQLQuery"
},
{
"$ref": "#/components/schemas/TimeToSeeDataSessionsQuery"
},
{
"$ref": "#/components/schemas/WebOverviewQuery"
},
{
"$ref": "#/components/schemas/WebStatsTableQuery"
},
{
"$ref": "#/components/schemas/WebTopClicksQuery"
}
],
"title": "Source",
"description": "Source of the events"
},
"columns": {
"type": "array",
"items": {
"type": "string"
},
"title": "Columns",
"default": null,
"nullable": true,
"description": "Columns shown in the table, unless the `source` provides them."
},
"embedded": {
"type": "boolean",
"title": "Embedded",
"default": null,
"nullable": true,
"description": "Uses the embedded version of LemonTable"
},
"expandable": {
"type": "boolean",
"title": "Expandable",
"default": null,
"nullable": true,
"description": "Can expand row to show raw event data (default: true)"
},
"showExport": {
"type": "boolean",
"title": "Showexport",
"default": null,
"nullable": true,
"description": "Show the export button"
},
"showReload": {
"type": "boolean",
"title": "Showreload",
"default": null,
"nullable": true,
"description": "Show a reload button"
},
"showSearch": {
"type": "boolean",
"title": "Showsearch",
"default": null,
"nullable": true,
"description": "Include a free text search field (PersonsNode only)"
},
"showActions": {
"type": "boolean",
"title": "Showactions",
"default": null,
"nullable": true,
"description": "Show the kebab menu at the end of the row"
},
"showTimings": {
"type": "boolean",
"title": "Showtimings",
"default": null,
"nullable": true,
"description": "Show a detailed query timing breakdown"
},
"allowSorting": {
"type": "boolean",
"title": "Allowsorting",
"default": null,
"nullable": true,
"description": "Can the user click on column headers to sort the table? (default: true)"
},
"hiddenColumns": {
"type": "array",
"items": {
"type": "string"
},
"title": "Hiddencolumns",
"default": null,
"nullable": true,
"description": "Columns that aren't shown in the table, even if in columns or returned data"
},
"showDateRange": {
"type": "boolean",
"title": "Showdaterange",
"default": null,
"nullable": true,
"description": "Show date range selector"
},
"showElapsedTime": {
"type": "boolean",
"title": "Showelapsedtime",
"default": null,
"nullable": true,
"description": "Show the time it takes to run a query"
},
"showEventFilter": {
"type": "boolean",
"title": "Showeventfilter",
"default": null,
"nullable": true,
"description": "Include an event filter above the table (EventsNode only)"
},
"showHogQLEditor": {
"type": "boolean",
"title": "Showhogqleditor",
"default": null,
"nullable": true,
"description": "Include a HogQL query editor above HogQL tables"
},
"propertiesViaUrl": {
"type": "boolean",
"title": "Propertiesviaurl",
"default": null,
"nullable": true,
"description": "Link properties via the URL (default: false)"
},
"showResultsTable": {
"type": "boolean",
"title": "Showresultstable",
"default": null,
"nullable": true,
"description": "Show a results table"
},
"showSavedQueries": {
"type": "boolean",
"title": "Showsavedqueries",
"default": null,
"nullable": true,
"description": "Shows a list of saved queries"
},
"showPropertyFilter": {
"type": "boolean",
"title": "Showpropertyfilter",
"default": null,
"nullable": true,
"description": "Include a property filter above the table"
},
"showOpenEditorButton": {
"type": "boolean",
"title": "Showopeneditorbutton",
"default": null,
"nullable": true,
"description": "Show a button to open the current query as a new insight. (default: true)"
},
"showColumnConfigurator": {
"type": "boolean",
"title": "Showcolumnconfigurator",
"default": null,
"nullable": true,
"description": "Show a button to configure the table's columns if possible"
},
"showTestAccountFilters": {
"type": "boolean",
"title": "Showtestaccountfilters",
"default": null,
"nullable": true,
"description": "Show filter to exclude test accounts"
},
"showPersistentColumnConfigurator": {
"type": "boolean",
"title": "Showpersistentcolumnconfigurator",
"default": null,
"nullable": true,
"description": "Show a button to configure and persist the table's default columns if possible"
}
}
}
DataVisualizationNode
{
"type": "object",
"title": "DataVisualizationNode",
"required": [
"source"
],
"properties": {
"kind": {
"const": "DataVisualizationNode",
"title": "Kind",
"default": "DataVisualizationNode"
},
"source": {
"$ref": "#/components/schemas/HogQLQuery"
},
"display": {
"$ref": "#/components/schemas/ChartDisplayTypeNullable"
},
"chartSettings": {
"$ref": "#/components/schemas/ChartSettingsNullable"
}
}
}
DataWarehouseEventsModifier
{
"type": "object",
"title": "DataWarehouseEventsModifier",
"required": [
"distinct_id_field",
"id_field",
"table_name",
"timestamp_field"
],
"properties": {
"id_field": {
"type": "string",
"title": "Id Field"
},
"table_name": {
"type": "string",
"title": "Table Name"
},
"timestamp_field": {
"type": "string",
"title": "Timestamp Field"
},
"distinct_id_field": {
"type": "string",
"title": "Distinct Id Field"
}
}
}
DataWarehouseNode
{
"type": "object",
"title": "DataWarehouseNode",
"required": [
"distinct_id_field",
"id",
"id_field",
"table_name",
"timestamp_field"
],
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"kind": {
"const": "DataWarehouseNode",
"title": "Kind",
"default": "DataWarehouseNode"
},
"math": {
"anyOf": [
{
"$ref": "#/components/schemas/BaseMathType"
},
{
"$ref": "#/components/schemas/PropertyMathType"
},
{
"$ref": "#/components/schemas/CountPerActorMathType"
},
{
"const": "unique_group"
},
{
"const": "hogql"
}
],
"title": "Math",
"default": null,
"nullable": true
},
"name": {
"type": "string",
"title": "Name",
"default": null,
"nullable": true
},
"id_field": {
"type": "string",
"title": "Id Field"
},
"response": {
"type": "object",
"title": "Response",
"default": null,
"nullable": true,
"description": "Cached query response"
},
"math_hogql": {
"type": "string",
"title": "Math Hogql",
"default": null,
"nullable": true
},
"properties": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ElementPropertyFilter"
},
{
"$ref": "#/components/schemas/SessionPropertyFilter"
},
{
"$ref": "#/components/schemas/CohortPropertyFilter"
},
{
"$ref": "#/components/schemas/RecordingDurationFilter"
},
{
"$ref": "#/components/schemas/GroupPropertyFilter"
},
{
"$ref": "#/components/schemas/FeaturePropertyFilter"
},
{
"$ref": "#/components/schemas/HogQLPropertyFilter"
},
{
"$ref": "#/components/schemas/EmptyPropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
}
]
},
"title": "Properties",
"default": null,
"nullable": true,
"description": "Properties configurable in the interface"
},
"table_name": {
"type": "string",
"title": "Table Name"
},
"custom_name": {
"type": "string",
"title": "Custom Name",
"default": null,
"nullable": true
},
"math_property": {
"type": "string",
"title": "Math Property",
"default": null,
"nullable": true
},
"fixedProperties": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ElementPropertyFilter"
},
{
"$ref": "#/components/schemas/SessionPropertyFilter"
},
{
"$ref": "#/components/schemas/CohortPropertyFilter"
},
{
"$ref": "#/components/schemas/RecordingDurationFilter"
},
{
"$ref": "#/components/schemas/GroupPropertyFilter"
},
{
"$ref": "#/components/schemas/FeaturePropertyFilter"
},
{
"$ref": "#/components/schemas/HogQLPropertyFilter"
},
{
"$ref": "#/components/schemas/EmptyPropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
}
]
},
"title": "Fixedproperties",
"default": null,
"nullable": true,
"description": "Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person)"
},
"timestamp_field": {
"type": "string",
"title": "Timestamp Field"
},
"distinct_id_field": {
"type": "string",
"title": "Distinct Id Field"
},
"math_group_type_index": {
"$ref": "#/components/schemas/MathGroupTypeIndexNullable"
}
}
}
DataWarehousePersonPropertyFilter
{
"type": "object",
"title": "DataWarehousePersonPropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "data_warehouse_person_property",
"title": "Type",
"default": "data_warehouse_person_property"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
DataWarehousePropertyFilter
{
"type": "object",
"title": "DataWarehousePropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "data_warehouse",
"title": "Type",
"default": "data_warehouse"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
DatabaseSchemaQuery
{
"type": "object",
"title": "DatabaseSchemaQuery",
"properties": {
"kind": {
"const": "DatabaseSchemaQuery",
"title": "Kind",
"default": "DatabaseSchemaQuery"
},
"response": {
"type": "object",
"title": "Response",
"default": null,
"nullable": true,
"description": "Cached query response",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatabaseSchemaQueryResponseField"
}
}
}
}
}
DatabaseSchemaQueryResponseField
{
"type": "object",
"title": "DatabaseSchemaQueryResponseField",
"required": [
"key",
"type"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"type": "string",
"title": "Type"
},
"chain": {
"type": "array",
"items": {
"type": "string"
},
"title": "Chain",
"default": null,
"nullable": true
},
"table": {
"type": "string",
"title": "Table",
"default": null,
"nullable": true
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"title": "Fields",
"default": null,
"nullable": true
}
}
}
DateRange
{
"type": "object",
"title": "DateRange",
"properties": {
"date_to": {
"type": "string",
"title": "Date To",
"default": null,
"nullable": true
},
"date_from": {
"type": "string",
"title": "Date From",
"default": null,
"nullable": true
},
"explicitDate": {
"type": "boolean",
"title": "Explicitdate",
"default": null,
"nullable": true,
"description": "Whether the date_from and date_to should be used verbatim. Disables rounding to the start and end of period."
}
}
}
DateRangeNullable
{
"type": "object",
"title": "DateRange",
"default": null,
"nullable": true,
"properties": {
"date_to": {
"type": "string",
"title": "Date To",
"default": null,
"nullable": true
},
"date_from": {
"type": "string",
"title": "Date From",
"default": null,
"nullable": true
},
"explicitDate": {
"type": "boolean",
"title": "Explicitdate",
"default": null,
"nullable": true,
"description": "Whether the date_from and date_to should be used verbatim. Disables rounding to the start and end of period."
}
}
}
DayItem
{
"type": "object",
"title": "DayItem",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "integer"
}
],
"title": "Value"
}
}
}
DisplayEnum
{
"enum": [
"ActionsLineGraph",
"ActionsLineGraphCumulative",
"ActionsTable",
"ActionsPie",
"ActionsBar",
"ActionsBarValue",
"WorldMap",
"BoldNumber"
],
"type": "string",
"description": "* `ActionsLineGraph` - ActionsLineGraph\n* `ActionsLineGraphCumulative` - ActionsLineGraphCumulative\n* `ActionsTable` - ActionsTable\n* `ActionsPie` - ActionsPie\n* `ActionsBar` - ActionsBar\n* `ActionsBarValue` - ActionsBarValue\n* `WorldMap` - WorldMap\n* `BoldNumber` - BoldNumber"
}
EarlyAccessFeature
{
"type": "object",
"required": [
"created_at",
"feature_flag",
"id",
"name",
"stage"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200
},
"stage": {
"$ref": "#/components/schemas/StageEnum"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string"
},
"feature_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"documentation_url": {
"type": "string",
"format": "uri",
"maxLength": 800
}
},
"x-konfig-properties": {
"feature_flag": {
"readOnly": true
}
}
}
EarlyAccessFeatureSerializerCreateOnly
{
"type": "object",
"required": [
"created_at",
"feature_flag",
"id",
"name",
"stage"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200
},
"stage": {
"$ref": "#/components/schemas/StageEnum"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string"
},
"feature_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"feature_flag_id": {
"type": "integer",
"writeOnly": true
},
"documentation_url": {
"type": "string",
"format": "uri",
"maxLength": 800
}
},
"x-konfig-properties": {
"feature_flag": {
"readOnly": true
}
}
}
EffectiveMembershipLevelEnum
{
"enum": [
1,
8,
15
],
"type": "integer"
}
EffectivePrivilegeLevelEnum
{
"enum": [
21,
37
],
"type": "integer"
}
EffectiveRestrictionLevelEnum
{
"enum": [
21,
37
],
"type": "integer"
}
ElementPropertyFilter
{
"type": "object",
"title": "ElementPropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"$ref": "#/components/schemas/Key"
},
"type": {
"const": "element",
"title": "Type",
"default": "element"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
ElementType
{
"type": "object",
"title": "ElementType",
"required": [
"attributes",
"tag_name"
],
"properties": {
"href": {
"type": "string",
"title": "Href",
"default": null,
"nullable": true
},
"text": {
"type": "string",
"title": "Text",
"default": null,
"nullable": true
},
"order": {
"type": "number",
"title": "Order",
"default": null,
"nullable": true
},
"attr_id": {
"type": "string",
"title": "Attr Id",
"default": null,
"nullable": true
},
"tag_name": {
"type": "string",
"title": "Tag Name"
},
"nth_child": {
"type": "number",
"title": "Nth Child",
"default": null,
"nullable": true
},
"attr_class": {
"type": "array",
"items": {
"type": "string"
},
"title": "Attr Class",
"default": null,
"nullable": true
},
"attributes": {
"type": "object",
"title": "Attributes",
"additionalProperties": {
"type": "string"
}
},
"nth_of_type": {
"type": "number",
"title": "Nth Of Type",
"default": null,
"nullable": true
}
}
}
EmptyPropertyFilter
{
"type": "object",
"title": "EmptyPropertyFilter",
"properties": {}
}
EntityType
{
"enum": [
"actions",
"events",
"data_warehouse",
"new_entity"
],
"type": "string",
"title": "EntityType"
}
EntityTypeNullable
{
"enum": [
"actions",
"events",
"data_warehouse",
"new_entity"
],
"type": "string",
"title": "EntityType",
"default": null,
"nullable": true
}
EventDefinition
{
"type": "object",
"title": "EventDefinition",
"required": [
"elements",
"event",
"properties"
],
"properties": {
"event": {
"type": "string",
"title": "Event"
},
"elements": {
"type": "array",
"items": {},
"title": "Elements"
},
"properties": {
"type": "object",
"title": "Properties"
}
}
}
EventOddsRatioSerialized
{
"type": "object",
"title": "EventOddsRatioSerialized",
"required": [
"correlation_type",
"event",
"failure_count",
"odds_ratio",
"success_count"
],
"properties": {
"event": {
"$ref": "#/components/schemas/EventDefinition"
},
"odds_ratio": {
"type": "number",
"title": "Odds Ratio"
},
"failure_count": {
"type": "integer",
"title": "Failure Count"
},
"success_count": {
"type": "integer",
"title": "Success Count"
},
"correlation_type": {
"$ref": "#/components/schemas/CorrelationType"
}
}
}
EventPropertyFilter
{
"type": "object",
"title": "EventPropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "event",
"title": "Type",
"default": "event",
"description": "Event properties"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
EventType
{
"type": "object",
"title": "EventType",
"required": [
"distinct_id",
"elements",
"event",
"id",
"properties",
"timestamp"
],
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"uuid": {
"type": "string",
"title": "Uuid",
"default": null,
"nullable": true
},
"event": {
"type": "string",
"title": "Event"
},
"person": {
"$ref": "#/components/schemas/PersonNullable"
},
"elements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementType"
},
"title": "Elements"
},
"timestamp": {
"type": "string",
"title": "Timestamp"
},
"properties": {
"type": "object",
"title": "Properties"
},
"distinct_id": {
"type": "string",
"title": "Distinct Id"
},
"elements_chain": {
"type": "string",
"title": "Elements Chain",
"default": null,
"nullable": true
}
}
}
EventsNode
{
"type": "object",
"title": "EventsNode",
"properties": {
"kind": {
"const": "EventsNode",
"title": "Kind",
"default": "EventsNode"
},
"math": {
"anyOf": [
{
"$ref": "#/components/schemas/BaseMathType"
},
{
"$ref": "#/components/schemas/PropertyMathType"
},
{
"$ref": "#/components/schemas/CountPerActorMathType"
},
{
"const": "unique_group"
},
{
"const": "hogql"
}
],
"title": "Math",
"default": null,
"nullable": true
},
"name": {
"type": "string",
"title": "Name",
"default": null,
"nullable": true
},
"event": {
"type": "string",
"title": "Event",
"default": null,
"nullable": true,
"description": "The event or `null` for all events."
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"orderBy": {
"type": "array",
"items": {
"type": "string"
},
"title": "Orderby",
"default": null,
"nullable": true,
"description": "Columns to order by"
},
"response": {
"$ref": "#/components/schemas/ResponseNullable"
},
"math_hogql": {
"type": "string",
"title": "Math Hogql",
"default": null,
"nullable": true
},
"properties": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ElementPropertyFilter"
},
{
"$ref": "#/components/schemas/SessionPropertyFilter"
},
{
"$ref": "#/components/schemas/CohortPropertyFilter"
},
{
"$ref": "#/components/schemas/RecordingDurationFilter"
},
{
"$ref": "#/components/schemas/GroupPropertyFilter"
},
{
"$ref": "#/components/schemas/FeaturePropertyFilter"
},
{
"$ref": "#/components/schemas/HogQLPropertyFilter"
},
{
"$ref": "#/components/schemas/EmptyPropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
}
]
},
"title": "Properties",
"default": null,
"nullable": true,
"description": "Properties configurable in the interface"
},
"custom_name": {
"type": "string",
"title": "Custom Name",
"default": null,
"nullable": true
},
"math_property": {
"type": "string",
"title": "Math Property",
"default": null,
"nullable": true
},
"fixedProperties": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ElementPropertyFilter"
},
{
"$ref": "#/components/schemas/SessionPropertyFilter"
},
{
"$ref": "#/components/schemas/CohortPropertyFilter"
},
{
"$ref": "#/components/schemas/RecordingDurationFilter"
},
{
"$ref": "#/components/schemas/GroupPropertyFilter"
},
{
"$ref": "#/components/schemas/FeaturePropertyFilter"
},
{
"$ref": "#/components/schemas/HogQLPropertyFilter"
},
{
"$ref": "#/components/schemas/EmptyPropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
}
]
},
"title": "Fixedproperties",
"default": null,
"nullable": true,
"description": "Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person)"
},
"math_group_type_index": {
"$ref": "#/components/schemas/MathGroupTypeIndexNullable"
}
}
}
EventsQuery
{
"type": "object",
"title": "EventsQuery",
"required": [
"select"
],
"properties": {
"kind": {
"const": "EventsQuery",
"title": "Kind",
"default": "EventsQuery"
},
"after": {
"type": "string",
"title": "After",
"default": null,
"nullable": true,
"description": "Only fetch events that happened after this timestamp"
},
"event": {
"type": "string",
"title": "Event",
"default": null,
"nullable": true,
"description": "Limit to events matching this string"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true,
"description": "Number of rows to return"
},
"where": {
"type": "array",
"items": {
"type": "string"
},
"title": "Where",
"default": null,
"nullable": true,
"description": "HogQL filters to apply on returned data"
},
"before": {
"type": "string",
"title": "Before",
"default": null,
"nullable": true,
"description": "Only fetch events that happened before this timestamp"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true,
"description": "Number of rows to skip before returning rows"
},
"select": {
"type": "array",
"items": {
"type": "string"
},
"title": "Select",
"description": "Return a limited set of data. Required."
},
"orderBy": {
"type": "array",
"items": {
"type": "string"
},
"title": "Orderby",
"default": null,
"nullable": true,
"description": "Columns to order by"
},
"actionId": {
"type": "integer",
"title": "Actionid",
"default": null,
"nullable": true,
"description": "Show events matching a given action"
},
"personId": {
"type": "string",
"title": "Personid",
"default": null,
"nullable": true,
"description": "Show events for a given person"
},
"response": {
"$ref": "#/components/schemas/EventsQueryResponseNullable"
},
"properties": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ElementPropertyFilter"
},
{
"$ref": "#/components/schemas/SessionPropertyFilter"
},
{
"$ref": "#/components/schemas/CohortPropertyFilter"
},
{
"$ref": "#/components/schemas/RecordingDurationFilter"
},
{
"$ref": "#/components/schemas/GroupPropertyFilter"
},
{
"$ref": "#/components/schemas/FeaturePropertyFilter"
},
{
"$ref": "#/components/schemas/HogQLPropertyFilter"
},
{
"$ref": "#/components/schemas/EmptyPropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
}
]
},
"title": "Properties",
"default": null,
"nullable": true,
"description": "Properties configurable in the interface"
},
"fixedProperties": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ElementPropertyFilter"
},
{
"$ref": "#/components/schemas/SessionPropertyFilter"
},
{
"$ref": "#/components/schemas/CohortPropertyFilter"
},
{
"$ref": "#/components/schemas/RecordingDurationFilter"
},
{
"$ref": "#/components/schemas/GroupPropertyFilter"
},
{
"$ref": "#/components/schemas/FeaturePropertyFilter"
},
{
"$ref": "#/components/schemas/HogQLPropertyFilter"
},
{
"$ref": "#/components/schemas/EmptyPropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
}
]
},
"title": "Fixedproperties",
"default": null,
"nullable": true,
"description": "Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person)"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Filter test accounts"
}
}
}
EventsQueryResponse
{
"type": "object",
"title": "EventsQueryResponse",
"required": [
"columns",
"hogql",
"results",
"types"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"title": "Types"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns"
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"type": "array",
"items": {}
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
}
}
EventsQueryResponseNullable
{
"type": "object",
"title": "EventsQueryResponse",
"default": null,
"nullable": true,
"required": [
"columns",
"hogql",
"results",
"types"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"title": "Types"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns"
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"type": "array",
"items": {}
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
},
"description": "Cached query response"
}
Experiment
{
"type": "object",
"required": [
"created_at",
"created_by",
"feature_flag",
"feature_flag_key",
"id",
"name",
"updated_at"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 400
},
"filters": {},
"archived": {
"type": "boolean"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"parameters": {
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"feature_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"feature_flag_key": {
"type": "string"
},
"secondary_metrics": {
"nullable": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"feature_flag": {
"readOnly": true
}
}
}
ExplicitTeamMember
{
"type": "object",
"required": [
"effective_level",
"id",
"joined_at",
"parent_level",
"parent_membership_id",
"updated_at",
"user",
"user_uuid"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"level": {
"$ref": "#/components/schemas/ExplicitTeamMemberLevelEnum"
},
"joined_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"user_uuid": {
"type": "string",
"format": "uuid",
"writeOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"parent_level": {
"type": "integer",
"readOnly": true
},
"effective_level": {
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
},
"parent_membership_id": {
"type": "string",
"format": "uuid",
"readOnly": true
}
},
"x-konfig-properties": {
"user": {
"readOnly": true
},
"level": {
"maximum": 32767,
"minimum": 0
},
"effective_level": {
"readOnly": true,
"description": "If organization level is higher than project level, then that takes precedence over explicit project level."
}
}
}
ExplicitTeamMemberLevelEnum
{
"enum": [
1,
8
],
"type": "integer",
"description": "* `1` - member\n* `8` - administrator"
}
ExplicitmembersGetMembersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
ExportFormatEnum
{
"enum": [
"image/png",
"application/pdf",
"text/csv",
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
],
"type": "string",
"description": "* `image/png` - image/png\n* `application/pdf` - application/pdf\n* `text/csv` - text/csv\n* `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
}
ExportedAsset
{
"type": "object",
"required": [
"created_at",
"export_format",
"filename",
"has_content",
"id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"insight": {
"type": "integer",
"nullable": true
},
"filename": {
"type": "string",
"readOnly": true
},
"dashboard": {
"type": "integer",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"has_content": {
"type": "string",
"readOnly": true
},
"expires_after": {
"type": "string",
"format": "date-time",
"nullable": true
},
"export_format": {
"$ref": "#/components/schemas/ExportFormatEnum"
},
"export_context": {
"nullable": true
}
},
"description": "Standard ExportedAsset serializer that doesn't return content."
}
FeatureFlag
{
"type": "object",
"required": [
"can_edit",
"created_by",
"experiment_set",
"features",
"id",
"is_simple_flag",
"key",
"rollout_percentage",
"surveys",
"usage_dashboard"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"key": {
"type": "string",
"maxLength": 400
},
"name": {
"type": "string",
"description": "contains the description for the flag (field name `name` is kept for backwards-compatibility)"
},
"tags": {
"type": "array",
"items": {}
},
"active": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"filters": {
"type": "object",
"additionalProperties": {}
},
"surveys": {
"type": "object",
"readOnly": true,
"additionalProperties": {}
},
"can_edit": {
"type": "boolean",
"readOnly": true
},
"features": {
"type": "object",
"readOnly": true,
"additionalProperties": {}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"experiment_set": {
"type": "array",
"items": {
"type": "integer"
},
"readOnly": true
},
"is_simple_flag": {
"type": "boolean",
"readOnly": true
},
"usage_dashboard": {
"type": "integer",
"readOnly": true
},
"performed_rollback": {
"type": "boolean",
"nullable": true
},
"rollout_percentage": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"rollback_conditions": {
"nullable": true
},
"analytics_dashboards": {
"type": "array",
"items": {
"type": "integer"
}
},
"has_enriched_analytics": {
"type": "boolean",
"nullable": true
},
"ensure_experience_continuity": {
"type": "boolean",
"nullable": true
}
},
"description": "Serializer mixin that resolves appropriate response for tags depending on license.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
FeatureFlagRoleAccess
{
"type": "object",
"required": [
"added_at",
"feature_flag",
"id",
"role",
"role_id",
"updated_at"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"role": {
"$ref": "#/components/schemas/Role"
},
"role_id": {
"type": "string",
"format": "uuid",
"writeOnly": true
},
"added_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"feature_flag": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"x-konfig-properties": {
"role": {
"readOnly": true
},
"feature_flag": {
"readOnly": true
}
}
}
FeatureFlagsAccessLevelEnum
{
"enum": [
21,
37
],
"type": "integer",
"description": "* `21` - Can only view\n* `37` - Can always edit"
}
FeaturePropertyFilter
{
"type": "object",
"title": "FeaturePropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "feature",
"title": "Type",
"default": "feature",
"description": "Event property with \"$feature/\" prepended"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
FilterAction
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "ID of the action to filter on. For example `2841`."
},
"math": {
"$ref": "#/components/schemas/MathEnum"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
}
}
},
"x-konfig-properties": {
"math": {
"default": "total",
"description": "How to aggregate results, shown as \"counted by\" in the interface.\n- `total` (default): no aggregation, count by events\n- `dau`: count by unique users. Despite the name, if you select the `interval` to be weekly or monthly, this will show weekly or monthly active users respectively\n- `weekly_active`: rolling average of users of the last 7 days.\n- `monthly_active`: rolling average of users of the last month.\n- `unique_group`: count by group. Requires `math_group_type_index` to be sent. You can get the index by hitting `/api/projects/@current/groups_types/`.\n\nAll of the below are property aggregations, and require `math_property` to be sent with an event property.\n- `sum`: sum of a numeric property.\n- `min`: min of a numeric property.\n- `max`: max of a numeric property.\n- `median`: median of a numeric property.\n- `p90`: 90th percentile of a numeric property.\n- `p95` 95th percentile of a numeric property.\n- `p99`: 99th percentile of a numeric property.\n\n\n* `total` - total\n* `dau` - dau\n* `weekly_active` - weekly_active\n* `monthly_active` - monthly_active\n* `unique_group` - unique_group\n* `unique_session` - unique_session\n* `sum` - sum\n* `min` - min\n* `max` - max\n* `avg` - avg\n* `median` - median\n* `p90` - p90\n* `p95` - p95\n* `p99` - p99\n* `min_count_per_actor` - min_count_per_actor\n* `max_count_per_actor` - max_count_per_actor\n* `avg_count_per_actor` - avg_count_per_actor\n* `median_count_per_actor` - median_count_per_actor\n* `p90_count_per_actor` - p90_count_per_actor\n* `p95_count_per_actor` - p95_count_per_actor\n* `p99_count_per_actor` - p99_count_per_actor\n* `hogql` - hogql"
}
}
}
FilterEvent
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Name of the event to filter on. For example `$pageview` or `user sign up`."
},
"math": {
"$ref": "#/components/schemas/MathEnum"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
}
}
},
"x-konfig-properties": {
"math": {
"default": "total",
"description": "How to aggregate results, shown as \"counted by\" in the interface.\n- `total` (default): no aggregation, count by events\n- `dau`: count by unique users. Despite the name, if you select the `interval` to be weekly or monthly, this will show weekly or monthly active users respectively\n- `weekly_active`: rolling average of users of the last 7 days.\n- `monthly_active`: rolling average of users of the last month.\n- `unique_group`: count by group. Requires `math_group_type_index` to be sent. You can get the index by hitting `/api/projects/@current/groups_types/`.\n\nAll of the below are property aggregations, and require `math_property` to be sent with an event property.\n- `sum`: sum of a numeric property.\n- `min`: min of a numeric property.\n- `max`: max of a numeric property.\n- `median`: median of a numeric property.\n- `p90`: 90th percentile of a numeric property.\n- `p95` 95th percentile of a numeric property.\n- `p99`: 99th percentile of a numeric property.\n\n\n* `total` - total\n* `dau` - dau\n* `weekly_active` - weekly_active\n* `monthly_active` - monthly_active\n* `unique_group` - unique_group\n* `unique_session` - unique_session\n* `sum` - sum\n* `min` - min\n* `max` - max\n* `avg` - avg\n* `median` - median\n* `p90` - p90\n* `p95` - p95\n* `p99` - p99\n* `min_count_per_actor` - min_count_per_actor\n* `max_count_per_actor` - max_count_per_actor\n* `avg_count_per_actor` - avg_count_per_actor\n* `median_count_per_actor` - median_count_per_actor\n* `p90_count_per_actor` - p90_count_per_actor\n* `p95_count_per_actor` - p95_count_per_actor\n* `p99_count_per_actor` - p99_count_per_actor\n* `hogql` - hogql"
}
}
}
FilterLogicalOperator
{
"enum": [
"AND",
"OR"
],
"type": "string",
"title": "FilterLogicalOperator"
}
FrequencyEnum
{
"enum": [
"daily",
"weekly",
"monthly",
"yearly"
],
"type": "string",
"description": "* `daily` - Daily\n* `weekly` - Weekly\n* `monthly` - Monthly\n* `yearly` - Yearly"
}
Funnel
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterEvent"
},
"description": "Events to filter on. One of `events` or `actions` is required."
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterAction"
},
"description": "Actions to filter on. One of `events` or `actions` is required."
},
"date_to": {
"type": "string",
"default": "-7d",
"description": "What date to filter the results to. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year."
},
"breakdown": {
"type": "string",
"description": "A property or cohort to break down on. You can select the type of the property with breakdown_type.\n- `event` (default): a property key\n- `person`: a person property key\n- `cohort`: an array of cohort IDs (ie `[9581,5812]`)"
},
"date_from": {
"type": "string",
"default": "-7d",
"description": "What date to filter the results from. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year."
},
"exclusions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FunnelExclusion"
},
"description": "Exclude users/groups that completed the specified event between two specific steps. Note that these users/groups will be completely excluded from the entire funnel."
},
"properties": {
"$ref": "#/components/schemas/Property"
},
"breakdown_type": {
"$ref": "#/components/schemas/BreakdownTypeEnum"
},
"breakdown_limit": {
"type": "integer",
"default": 10
},
"funnel_viz_type": {
"$ref": "#/components/schemas/FunnelVizTypeEnum"
},
"funnel_order_type": {
"$ref": "#/components/schemas/FunnelOrderTypeEnum"
},
"funnel_window_days": {
"type": "integer",
"default": 14,
"description": "(DEPRECATED) Funnel window size in days. Use `funnel_window_interval` and `funnel_window_interval_type`"
},
"filter_test_accounts": {
"type": "boolean",
"default": false,
"description": "Whether to filter out internal and test accounts. See \"project settings\" in your PostHog account for the filters."
},
"funnel_window_interval": {
"type": "integer",
"default": 14,
"description": "Funnel window size. Set in combination with funnel_window_interval, so defaults to 'days'."
},
"funnel_window_interval_type": {
"$ref": "#/components/schemas/FunnelWindowIntervalTypeEnum"
},
"aggregation_group_type_index": {
"type": "integer",
"default": 0,
"description": "Aggregate by users or by groups. `0` means user, `>0` means a group. See interface for the corresponding ID of the group."
}
},
"x-konfig-properties": {
"properties": {
"description": "Filter events by event property, person property, cohort, groups and more."
},
"breakdown_type": {
"default": "event",
"description": "Type of property to break down on.\n\n* `event` - event\n* `person` - person\n* `cohort` - cohort\n* `group` - group\n* `session` - session\n* `hogql` - hogql"
},
"funnel_viz_type": {
"default": "steps",
"description": "The visualisation type.\n- `steps` Track instances progress between steps of the funnel\n- `trends` Track how this funnel's conversion rate is trending over time.\n- `time_to_convert` Track how long it takes for instances to convert\n\n* `trends` - trends\n* `time_to_convert` - time_to_convert\n* `steps` - steps"
},
"funnel_order_type": {
"default": "ordered",
"description": "- `ordered` - Step B must happen after Step A, but any number events can happen between A and B.\n- `strict` - Step B must happen directly after Step A without any events in between.\n- `unordered` - Steps can be completed in any sequence.\n\n* `strict` - strict\n* `unordered` - unordered\n* `ordered` - ordered"
},
"funnel_window_interval_type": {
"default": "days",
"description": "The type of interval. Used in combination with `funnel_window_intervals`.\n\n* `DAY` - DAY\n* `SECOND` - SECOND\n* `MINUTE` - MINUTE\n* `HOUR` - HOUR\n* `WEEK` - WEEK\n* `MONTH` - MONTH"
}
}
}
FunnelConversionWindowTimeUnit
{
"enum": [
"second",
"minute",
"hour",
"day",
"week",
"month"
],
"type": "string",
"title": "FunnelConversionWindowTimeUnit"
}