FunnelConversionWindowTimeUnitNullable
{
"enum": [
"second",
"minute",
"hour",
"day",
"week",
"month"
],
"type": "string",
"title": "FunnelConversionWindowTimeUnit",
"default": null,
"nullable": true
}
FunnelCorrelationActorsQuery
{
"type": "object",
"title": "FunnelCorrelationActorsQuery",
"required": [
"source"
],
"properties": {
"kind": {
"const": "FunnelCorrelationActorsQuery",
"title": "Kind",
"default": "FunnelCorrelationActorsQuery"
},
"source": {
"$ref": "#/components/schemas/FunnelCorrelationQuery"
},
"response": {
"$ref": "#/components/schemas/ActorsQueryResponseNullable"
},
"includeRecordings": {
"type": "boolean",
"title": "Includerecordings",
"default": null,
"nullable": true
},
"funnelCorrelationPersonEntity": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/DataWarehouseNode"
}
],
"title": "Funnelcorrelationpersonentity",
"default": null,
"nullable": true
},
"funnelCorrelationPropertyValues": {
"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": "Funnelcorrelationpropertyvalues",
"default": null,
"nullable": true
},
"funnelCorrelationPersonConverted": {
"type": "boolean",
"title": "Funnelcorrelationpersonconverted",
"default": null,
"nullable": true
}
}
}
FunnelCorrelationQuery
{
"type": "object",
"title": "FunnelCorrelationQuery",
"required": [
"funnelCorrelationType",
"source"
],
"properties": {
"kind": {
"const": "FunnelCorrelationQuery",
"title": "Kind",
"default": "FunnelCorrelationQuery"
},
"source": {
"$ref": "#/components/schemas/FunnelsActorsQuery"
},
"response": {
"$ref": "#/components/schemas/FunnelCorrelationResponseNullable"
},
"funnelCorrelationType": {
"$ref": "#/components/schemas/FunnelCorrelationResultsType"
},
"funnelCorrelationNames": {
"type": "array",
"items": {
"type": "string"
},
"title": "Funnelcorrelationnames",
"default": null,
"nullable": true
},
"funnelCorrelationEventNames": {
"type": "array",
"items": {
"type": "string"
},
"title": "Funnelcorrelationeventnames",
"default": null,
"nullable": true
},
"funnelCorrelationExcludeNames": {
"type": "array",
"items": {
"type": "string"
},
"title": "Funnelcorrelationexcludenames",
"default": null,
"nullable": true
},
"funnelCorrelationExcludeEventNames": {
"type": "array",
"items": {
"type": "string"
},
"title": "Funnelcorrelationexcludeeventnames",
"default": null,
"nullable": true
},
"funnelCorrelationEventExcludePropertyNames": {
"type": "array",
"items": {
"type": "string"
},
"title": "Funnelcorrelationeventexcludepropertynames",
"default": null,
"nullable": true
}
}
}
FunnelCorrelationResponse
{
"type": "object",
"title": "FunnelCorrelationResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"$ref": "#/components/schemas/FunnelCorrelationResult"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
}
}
FunnelCorrelationResponseNullable
{
"type": "object",
"title": "FunnelCorrelationResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"$ref": "#/components/schemas/FunnelCorrelationResult"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
}
}
FunnelCorrelationResult
{
"type": "object",
"title": "FunnelCorrelationResult",
"required": [
"events",
"skewed"
],
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventOddsRatioSerialized"
},
"title": "Events"
},
"skewed": {
"type": "boolean",
"title": "Skewed"
}
}
}
FunnelCorrelationResultsType
{
"enum": [
"events",
"properties",
"event_with_properties"
],
"type": "string",
"title": "FunnelCorrelationResultsType"
}
FunnelExclusion
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Name of the event to filter on. For example `$pageview` or `user sign up`."
},
"properties": {
"$ref": "#/components/schemas/Property"
},
"funnel_to_step": {
"type": "integer",
"default": 1
},
"funnel_from_step": {
"type": "integer",
"default": 0
}
},
"x-konfig-properties": {
"properties": {
"description": "Filter events by event property, person property, cohort, groups and more."
}
}
}
FunnelExclusionActionsNode
{
"type": "object",
"title": "FunnelExclusionActionsNode",
"required": [
"funnelFromStep",
"funnelToStep",
"id"
],
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"kind": {
"const": "ActionsNode",
"title": "Kind",
"default": "ActionsNode"
},
"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
},
"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"
},
"custom_name": {
"type": "string",
"title": "Custom Name",
"default": null,
"nullable": true
},
"funnelToStep": {
"type": "integer",
"title": "Funneltostep"
},
"math_property": {
"type": "string",
"title": "Math Property",
"default": null,
"nullable": true
},
"funnelFromStep": {
"type": "integer",
"title": "Funnelfromstep"
},
"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"
}
}
}
FunnelExclusionEventsNode
{
"type": "object",
"title": "FunnelExclusionEventsNode",
"required": [
"funnelFromStep",
"funnelToStep"
],
"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
},
"funnelToStep": {
"type": "integer",
"title": "Funneltostep"
},
"math_property": {
"type": "string",
"title": "Math Property",
"default": null,
"nullable": true
},
"funnelFromStep": {
"type": "integer",
"title": "Funnelfromstep"
},
"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"
}
}
}
FunnelLayout
{
"enum": [
"horizontal",
"vertical"
],
"type": "string",
"title": "FunnelLayout"
}
FunnelLayoutNullable
{
"enum": [
"horizontal",
"vertical"
],
"type": "string",
"title": "FunnelLayout",
"default": null,
"nullable": true
}
FunnelOrderTypeEnum
{
"enum": [
"strict",
"unordered",
"ordered"
],
"type": "string",
"description": "* `strict` - strict\n* `unordered` - unordered\n* `ordered` - ordered"
}
FunnelPathType
{
"enum": [
"funnel_path_before_step",
"funnel_path_between_steps",
"funnel_path_after_step"
],
"type": "string",
"title": "FunnelPathType"
}
FunnelPathTypeNullable
{
"enum": [
"funnel_path_before_step",
"funnel_path_between_steps",
"funnel_path_after_step"
],
"type": "string",
"title": "FunnelPathType",
"default": null,
"nullable": true
}
FunnelPathsFilter
{
"type": "object",
"title": "FunnelPathsFilter",
"required": [
"funnelSource"
],
"properties": {
"funnelStep": {
"type": "integer",
"title": "Funnelstep",
"default": null,
"nullable": true
},
"funnelSource": {
"$ref": "#/components/schemas/FunnelsQuery"
},
"funnelPathType": {
"$ref": "#/components/schemas/FunnelPathTypeNullable"
}
}
}
FunnelPathsFilterNullable
{
"type": "object",
"title": "FunnelPathsFilter",
"default": null,
"nullable": true,
"required": [
"funnelSource"
],
"properties": {
"funnelStep": {
"type": "integer",
"title": "Funnelstep",
"default": null,
"nullable": true
},
"funnelSource": {
"$ref": "#/components/schemas/FunnelsQuery"
},
"funnelPathType": {
"$ref": "#/components/schemas/FunnelPathTypeNullable"
}
},
"description": "Used for displaying paths in relation to funnel steps."
}
FunnelStepReference
{
"enum": [
"total",
"previous"
],
"type": "string",
"title": "FunnelStepReference"
}
FunnelStepReferenceNullable
{
"enum": [
"total",
"previous"
],
"type": "string",
"title": "FunnelStepReference",
"default": null,
"nullable": true
}
FunnelStepsResult
{
"type": "object",
"required": [
"action_id",
"average_conversion_time",
"converted_people_url",
"count",
"dropped_people_url",
"median_conversion_time",
"order"
],
"properties": {
"count": {
"type": "integer",
"description": "Number of people in this step."
},
"order": {
"type": "string",
"description": "Order of this step in the funnel. The API should return the steps in order anyway."
},
"action_id": {
"type": "string",
"description": "Corresponds to the `id` of the entities passed through to `events` or `actions`."
},
"dropped_people_url": {
"type": "string",
"description": "Path of a URL to get a list of people that dropped after this step. In this format: `/api/person/funnel?...`"
},
"converted_people_url": {
"type": "string",
"description": "Path of a URL to get a list of people that converted after this step. In this format: `/api/person/funnel?...`"
},
"median_conversion_time": {
"type": "number",
"format": "double",
"description": "Median conversion time of person or groups between steps. `null` for the first step."
},
"average_conversion_time": {
"type": "number",
"format": "double",
"description": "Average conversion time of person or groups between steps. `null` for the first step."
}
}
}
FunnelStepsResults
{
"type": "object",
"required": [
"is_cached",
"last_refresh",
"result"
],
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FunnelStepsResult"
}
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"is_cached": {
"type": "boolean",
"description": "Whether the result is cached. To force a refresh, pass ?refresh=true"
},
"last_refresh": {
"type": "string",
"format": "date-time",
"description": "If the result is cached, when it was last refreshed."
}
},
"x-konfig-properties": {
"timezone": {
"default": "UTC",
"description": "Timezone the chart is displayed in\n\n* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Asmera` - Africa/Asmera\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Timbuktu` - Africa/Timbuktu\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Atka` - America/Atka\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Buenos_Aires` - America/Buenos_Aires\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Catamarca` - America/Catamarca\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Coral_Harbour` - America/Coral_Harbour\n* `America/Cordoba` - America/Cordoba\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Ensenada` - America/Ensenada\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fort_Wayne` - America/Fort_Wayne\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Godthab` - America/Godthab\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Indianapolis` - America/Indianapolis\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Jujuy` - America/Jujuy\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Knox_IN` - America/Knox_IN\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Louisville` - America/Louisville\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Mendoza` - America/Mendoza\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montreal` - America/Montreal\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nipigon` - America/Nipigon\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Pangnirtung` - America/Pangnirtung\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Acre` - America/Porto_Acre\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rainy_River` - America/Rainy_River\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Rosario` - America/Rosario\n* `America/Santa_Isabel` - America/Santa_Isabel\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Shiprock` - America/Shiprock\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Thunder_Bay` - America/Thunder_Bay\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Virgin` - America/Virgin\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `America/Yellowknife` - America/Yellowknife\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/South_Pole` - Antarctica/South_Pole\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Ashkhabad` - Asia/Ashkhabad\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Calcutta` - Asia/Calcutta\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Chongqing` - Asia/Chongqing\n* `Asia/Chungking` - Asia/Chungking\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Dacca` - Asia/Dacca\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Harbin` - Asia/Harbin\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Istanbul` - Asia/Istanbul\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kashgar` - Asia/Kashgar\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Katmandu` - Asia/Katmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macao` - Asia/Macao\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Rangoon` - Asia/Rangoon\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Saigon` - Asia/Saigon\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Tel_Aviv` - Asia/Tel_Aviv\n* `Asia/Thimbu` - Asia/Thimbu\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ujung_Pandang` - Asia/Ujung_Pandang\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Ulan_Bator` - Asia/Ulan_Bator\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faeroe` - Atlantic/Faeroe\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/ACT` - Australia/ACT\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Canberra` - Australia/Canberra\n* `Australia/Currie` - Australia/Currie\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/LHI` - Australia/LHI\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/NSW` - Australia/NSW\n* `Australia/North` - Australia/North\n* `Australia/Perth` - Australia/Perth\n* `Australia/Queensland` - Australia/Queensland\n* `Australia/South` - Australia/South\n* `Australia/Sydney` - Australia/Sydney\n* `Australia/Tasmania` - Australia/Tasmania\n* `Australia/Victoria` - Australia/Victoria\n* `Australia/West` - Australia/West\n* `Australia/Yancowinna` - Australia/Yancowinna\n* `Brazil/Acre` - Brazil/Acre\n* `Brazil/DeNoronha` - Brazil/DeNoronha\n* `Brazil/East` - Brazil/East\n* `Brazil/West` - Brazil/West\n* `CET` - CET\n* `CST6CDT` - CST6CDT\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Canada/Saskatchewan` - Canada/Saskatchewan\n* `Canada/Yukon` - Canada/Yukon\n* `Chile/Continental` - Chile/Continental\n* `Chile/EasterIsland` - Chile/EasterIsland\n* `Cuba` - Cuba\n* `EET` - EET\n* `EST` - EST\n* `EST5EDT` - EST5EDT\n* `Egypt` - Egypt\n* `Eire` - Eire\n* `Etc/GMT` - Etc/GMT\n* `Etc/GMT+0` - Etc/GMT+0\n* `Etc/GMT+1` - Etc/GMT+1\n* `Etc/GMT+10` - Etc/GMT+10\n* `Etc/GMT+11` - Etc/GMT+11\n* `Etc/GMT+12` - Etc/GMT+12\n* `Etc/GMT+2` - Etc/GMT+2\n* `Etc/GMT+3` - Etc/GMT+3\n* `Etc/GMT+4` - Etc/GMT+4\n* `Etc/GMT+5` - Etc/GMT+5\n* `Etc/GMT+6` - Etc/GMT+6\n* `Etc/GMT+7` - Etc/GMT+7\n* `Etc/GMT+8` - Etc/GMT+8\n* `Etc/GMT+9` - Etc/GMT+9\n* `Etc/GMT-0` - Etc/GMT-0\n* `Etc/GMT-1` - Etc/GMT-1\n* `Etc/GMT-10` - Etc/GMT-10\n* `Etc/GMT-11` - Etc/GMT-11\n* `Etc/GMT-12` - Etc/GMT-12\n* `Etc/GMT-13` - Etc/GMT-13\n* `Etc/GMT-14` - Etc/GMT-14\n* `Etc/GMT-2` - Etc/GMT-2\n* `Etc/GMT-3` - Etc/GMT-3\n* `Etc/GMT-4` - Etc/GMT-4\n* `Etc/GMT-5` - Etc/GMT-5\n* `Etc/GMT-6` - Etc/GMT-6\n* `Etc/GMT-7` - Etc/GMT-7\n* `Etc/GMT-8` - Etc/GMT-8\n* `Etc/GMT-9` - Etc/GMT-9\n* `Etc/GMT0` - Etc/GMT0\n* `Etc/Greenwich` - Etc/Greenwich\n* `Etc/UCT` - Etc/UCT\n* `Etc/UTC` - Etc/UTC\n* `Etc/Universal` - Etc/Universal\n* `Etc/Zulu` - Etc/Zulu\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belfast` - Europe/Belfast\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kiev` - Europe/Kiev\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Nicosia` - Europe/Nicosia\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Tiraspol` - Europe/Tiraspol\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Uzhgorod` - Europe/Uzhgorod\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zaporozhye` - Europe/Zaporozhye\n* `Europe/Zurich` - Europe/Zurich\n* `GB` - GB\n* `GB-Eire` - GB-Eire\n* `GMT` - GMT\n* `GMT+0` - GMT+0\n* `GMT-0` - GMT-0\n* `GMT0` - GMT0\n* `Greenwich` - Greenwich\n* `HST` - HST\n* `Hongkong` - Hongkong\n* `Iceland` - Iceland\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Iran` - Iran\n* `Israel` - Israel\n* `Jamaica` - Jamaica\n* `Japan` - Japan\n* `Kwajalein` - Kwajalein\n* `Libya` - Libya\n* `MET` - MET\n* `MST` - MST\n* `MST7MDT` - MST7MDT\n* `Mexico/BajaNorte` - Mexico/BajaNorte\n* `Mexico/BajaSur` - Mexico/BajaSur\n* `Mexico/General` - Mexico/General\n* `NZ` - NZ\n* `NZ-CHAT` - NZ-CHAT\n* `Navajo` - Navajo\n* `PRC` - PRC\n* `PST8PDT` - PST8PDT\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Enderbury` - Pacific/Enderbury\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Johnston` - Pacific/Johnston\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Ponape` - Pacific/Ponape\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Samoa` - Pacific/Samoa\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Truk` - Pacific/Truk\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `Pacific/Yap` - Pacific/Yap\n* `Poland` - Poland\n* `Portugal` - Portugal\n* `ROC` - ROC\n* `ROK` - ROK\n* `Singapore` - Singapore\n* `Turkey` - Turkey\n* `UCT` - UCT\n* `US/Alaska` - US/Alaska\n* `US/Aleutian` - US/Aleutian\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/East-Indiana` - US/East-Indiana\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Indiana-Starke` - US/Indiana-Starke\n* `US/Michigan` - US/Michigan\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `US/Samoa` - US/Samoa\n* `UTC` - UTC\n* `Universal` - Universal\n* `W-SU` - W-SU\n* `WET` - WET\n* `Zulu` - Zulu"
}
}
}
FunnelVizType
{
"enum": [
"steps",
"time_to_convert",
"trends"
],
"type": "string",
"title": "FunnelVizType"
}
FunnelVizTypeEnum
{
"enum": [
"trends",
"time_to_convert",
"steps"
],
"type": "string",
"description": "* `trends` - trends\n* `time_to_convert` - time_to_convert\n* `steps` - steps"
}
FunnelVizTypeNullable
{
"enum": [
"steps",
"time_to_convert",
"trends"
],
"type": "string",
"title": "FunnelVizType",
"default": null,
"nullable": true
}
FunnelWindowIntervalTypeEnum
{
"enum": [
"DAY",
"SECOND",
"MINUTE",
"HOUR",
"WEEK",
"MONTH"
],
"type": "string",
"description": "* `DAY` - DAY\n* `SECOND` - SECOND\n* `MINUTE` - MINUTE\n* `HOUR` - HOUR\n* `WEEK` - WEEK\n* `MONTH` - MONTH"
}
FunnelsActorsQuery
{
"type": "object",
"title": "FunnelsActorsQuery",
"required": [
"source"
],
"properties": {
"kind": {
"const": "FunnelsActorsQuery",
"title": "Kind",
"default": "FunnelsActorsQuery"
},
"source": {
"$ref": "#/components/schemas/FunnelsQuery"
},
"response": {
"$ref": "#/components/schemas/ActorsQueryResponseNullable"
},
"funnelStep": {
"type": "integer",
"title": "Funnelstep",
"default": null,
"nullable": true,
"description": "Index of the step for which we want to get the timestamp for, per person. Positive for converted persons, negative for dropped of persons."
},
"funnelCustomSteps": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Funnelcustomsteps",
"default": null,
"nullable": true,
"description": "Custom step numbers to get persons for. This overrides `funnelStep`. Primarily for correlation use."
},
"includeRecordings": {
"type": "boolean",
"title": "Includerecordings",
"default": null,
"nullable": true
},
"funnelStepBreakdown": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Funnelstepbreakdown",
"default": null,
"nullable": true,
"description": "The breakdown value for which to get persons for. This is an array for person and event properties, a string for groups and an integer for cohorts."
},
"funnelTrendsDropOff": {
"type": "boolean",
"title": "Funneltrendsdropoff",
"default": null,
"nullable": true
},
"funnelTrendsEntrancePeriodStart": {
"type": "string",
"title": "Funneltrendsentranceperiodstart",
"default": null,
"nullable": true,
"description": "Used together with `funnelTrendsDropOff` for funnels time conversion date for the persons modal."
}
}
}
FunnelsFilter
{
"type": "object",
"title": "FunnelsFilter",
"properties": {
"layout": {
"$ref": "#/components/schemas/FunnelLayoutNullable"
},
"binCount": {
"type": "integer",
"title": "Bincount",
"default": null,
"nullable": true
},
"exclusions": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/FunnelExclusionEventsNode"
},
{
"$ref": "#/components/schemas/FunnelExclusionActionsNode"
}
]
},
"title": "Exclusions",
"default": null,
"nullable": true
},
"funnelToStep": {
"type": "integer",
"title": "Funneltostep",
"default": null,
"nullable": true
},
"funnelVizType": {
"$ref": "#/components/schemas/FunnelVizTypeNullable"
},
"funnelFromStep": {
"type": "integer",
"title": "Funnelfromstep",
"default": null,
"nullable": true
},
"funnelOrderType": {
"$ref": "#/components/schemas/StepOrderValueNullable"
},
"funnelStepReference": {
"$ref": "#/components/schemas/FunnelStepReferenceNullable"
},
"funnelWindowInterval": {
"type": "integer",
"title": "Funnelwindowinterval",
"default": null,
"nullable": true
},
"funnelAggregateByHogQL": {
"type": "string",
"title": "Funnelaggregatebyhogql",
"default": null,
"nullable": true
},
"breakdownAttributionType": {
"$ref": "#/components/schemas/BreakdownAttributionTypeNullable"
},
"funnelWindowIntervalUnit": {
"$ref": "#/components/schemas/FunnelConversionWindowTimeUnitNullable"
},
"hidden_legend_breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"title": "Hidden Legend Breakdowns",
"default": null,
"nullable": true
},
"breakdownAttributionValue": {
"type": "integer",
"title": "Breakdownattributionvalue",
"default": null,
"nullable": true
}
}
}
FunnelsFilterNullable
{
"type": "object",
"title": "FunnelsFilter",
"default": null,
"nullable": true,
"properties": {
"layout": {
"$ref": "#/components/schemas/FunnelLayoutNullable"
},
"binCount": {
"type": "integer",
"title": "Bincount",
"default": null,
"nullable": true
},
"exclusions": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/FunnelExclusionEventsNode"
},
{
"$ref": "#/components/schemas/FunnelExclusionActionsNode"
}
]
},
"title": "Exclusions",
"default": null,
"nullable": true
},
"funnelToStep": {
"type": "integer",
"title": "Funneltostep",
"default": null,
"nullable": true
},
"funnelVizType": {
"$ref": "#/components/schemas/FunnelVizTypeNullable"
},
"funnelFromStep": {
"type": "integer",
"title": "Funnelfromstep",
"default": null,
"nullable": true
},
"funnelOrderType": {
"$ref": "#/components/schemas/StepOrderValueNullable"
},
"funnelStepReference": {
"$ref": "#/components/schemas/FunnelStepReferenceNullable"
},
"funnelWindowInterval": {
"type": "integer",
"title": "Funnelwindowinterval",
"default": null,
"nullable": true
},
"funnelAggregateByHogQL": {
"type": "string",
"title": "Funnelaggregatebyhogql",
"default": null,
"nullable": true
},
"breakdownAttributionType": {
"$ref": "#/components/schemas/BreakdownAttributionTypeNullable"
},
"funnelWindowIntervalUnit": {
"$ref": "#/components/schemas/FunnelConversionWindowTimeUnitNullable"
},
"hidden_legend_breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"title": "Hidden Legend Breakdowns",
"default": null,
"nullable": true
},
"breakdownAttributionValue": {
"type": "integer",
"title": "Breakdownattributionvalue",
"default": null,
"nullable": true
}
},
"description": "Properties specific to the funnels insight"
}
FunnelsQuery
{
"type": "object",
"title": "FunnelsQuery",
"required": [
"series"
],
"properties": {
"kind": {
"const": "FunnelsQuery",
"title": "Kind",
"default": "FunnelsQuery"
},
"series": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/DataWarehouseNode"
}
]
},
"title": "Series",
"description": "Events and actions to include"
},
"interval": {
"$ref": "#/components/schemas/IntervalTypeNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"anyOf": [
{
"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"
}
]
}
},
{
"$ref": "#/components/schemas/PropertyGroupFilter"
}
],
"title": "Properties",
"default": null,
"nullable": true,
"description": "Property filters for all series"
},
"funnelsFilter": {
"$ref": "#/components/schemas/FunnelsFilterNullable"
},
"samplingFactor": {
"type": "number",
"title": "Samplingfactor",
"default": null,
"nullable": true,
"description": "Sampling rate"
},
"breakdownFilter": {
"$ref": "#/components/schemas/BreakdownFilterNullable"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Exclude internal and test users by applying the respective filters"
},
"aggregation_group_type_index": {
"type": "integer",
"title": "Aggregation Group Type Index",
"default": null,
"nullable": true,
"description": "Groups aggregation"
}
}
}
GenericInsights
{
"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."
},
"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."
},
"properties": {
"$ref": "#/components/schemas/Property"
},
"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."
}
},
"x-konfig-properties": {
"properties": {
"description": "Filter events by event property, person property, cohort, groups and more."
}
}
}
GoalLine
{
"type": "object",
"title": "GoalLine",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"type": "number",
"title": "Value"
}
}
}
Group
{
"type": "object",
"required": [
"created_at",
"group_key",
"group_type_index"
],
"properties": {
"group_key": {
"type": "string",
"maxLength": 400
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"group_properties": {},
"group_type_index": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
}
}
}
GroupPropertyFilter
{
"type": "object",
"title": "GroupPropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "group",
"title": "Type",
"default": "group"
},
"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"
},
"group_type_index": {
"type": "number",
"title": "Group Type Index",
"default": null,
"nullable": true
}
}
}
GroupType
{
"type": "object",
"required": [
"group_type",
"group_type_index"
],
"properties": {
"group_type": {
"type": "string",
"readOnly": true
},
"name_plural": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"name_singular": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"group_type_index": {
"type": "integer",
"readOnly": true
}
}
}
GroupstypesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupType"
}
}
HogQLAutocomplete
{
"type": "object",
"title": "HogQLAutocomplete",
"required": [
"endPosition",
"select",
"startPosition"
],
"properties": {
"kind": {
"const": "HogQLAutocomplete",
"title": "Kind",
"default": "HogQLAutocomplete"
},
"select": {
"type": "string",
"title": "Select",
"description": "Full select query to validate"
},
"filters": {
"$ref": "#/components/schemas/HogQLFiltersNullable"
},
"response": {
"$ref": "#/components/schemas/HogQLAutocompleteResponseNullable"
},
"endPosition": {
"type": "integer",
"title": "Endposition",
"description": "End position of the editor word"
},
"startPosition": {
"type": "integer",
"title": "Startposition",
"description": "Start position of the editor word"
}
}
}
HogQLAutocompleteResponse
{
"type": "object",
"title": "HogQLAutocompleteResponse",
"required": [
"incomplete_list",
"suggestions"
],
"properties": {
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true,
"description": "Measured timings for different parts of the query generation process"
},
"suggestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutocompleteCompletionItem"
},
"title": "Suggestions"
},
"incomplete_list": {
"type": "boolean",
"title": "Incomplete List",
"description": "Whether or not the suggestions returned are complete"
}
}
}
HogQLAutocompleteResponseNullable
{
"type": "object",
"title": "HogQLAutocompleteResponse",
"default": null,
"nullable": true,
"required": [
"incomplete_list",
"suggestions"
],
"properties": {
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true,
"description": "Measured timings for different parts of the query generation process"
},
"suggestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutocompleteCompletionItem"
},
"title": "Suggestions"
},
"incomplete_list": {
"type": "boolean",
"title": "Incomplete List",
"description": "Whether or not the suggestions returned are complete"
}
},
"description": "Cached query response"
}
HogQLFilters
{
"type": "object",
"title": "HogQLFilters",
"properties": {
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"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
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true
}
}
}
HogQLFiltersNullable
{
"type": "object",
"title": "HogQLFilters",
"default": null,
"nullable": true,
"properties": {
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"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
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true
}
}
}
HogQLMetadata
{
"type": "object",
"title": "HogQLMetadata",
"properties": {
"expr": {
"type": "string",
"title": "Expr",
"default": null,
"nullable": true,
"description": "HogQL expression to validate (use `select` or `expr`, but not both)"
},
"kind": {
"const": "HogQLMetadata",
"title": "Kind",
"default": "HogQLMetadata"
},
"debug": {
"type": "boolean",
"title": "Debug",
"default": null,
"nullable": true,
"description": "Enable more verbose output, usually run from the /debug page"
},
"table": {
"type": "string",
"title": "Table",
"default": null,
"nullable": true,
"description": "Table to validate the expression against"
},
"select": {
"type": "string",
"title": "Select",
"default": null,
"nullable": true,
"description": "Full select query to validate (use `select` or `expr`, but not both)"
},
"filters": {
"$ref": "#/components/schemas/HogQLFiltersNullable"
},
"response": {
"$ref": "#/components/schemas/HogQLMetadataResponseNullable"
},
"exprSource": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/PersonsNode"
},
{
"$ref": "#/components/schemas/TimeToSeeDataSessionsQuery"
},
{
"$ref": "#/components/schemas/EventsQuery"
},
{
"$ref": "#/components/schemas/ActorsQuery"
},
{
"$ref": "#/components/schemas/InsightActorsQuery"
},
{
"$ref": "#/components/schemas/InsightActorsQueryOptions"
},
{
"$ref": "#/components/schemas/SessionsTimelineQuery"
},
{
"$ref": "#/components/schemas/HogQLQuery"
},
{
"$ref": "#/components/schemas/HogQLMetadata"
},
{
"$ref": "#/components/schemas/HogQLAutocomplete"
},
{
"$ref": "#/components/schemas/WebOverviewQuery"
},
{
"$ref": "#/components/schemas/WebStatsTableQuery"
},
{
"$ref": "#/components/schemas/WebTopClicksQuery"
}
],
"title": "Exprsource",
"default": null,
"nullable": true,
"description": "Query within which \"expr\" is validated. Defaults to \"select * from events\""
}
}
}
HogQLMetadataResponse
{
"type": "object",
"title": "HogQLMetadataResponse",
"required": [
"errors",
"notices",
"warnings"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Errors"
},
"isValid": {
"type": "boolean",
"title": "Isvalid",
"default": null,
"nullable": true
},
"notices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Notices"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Warnings"
},
"inputExpr": {
"type": "string",
"title": "Inputexpr",
"default": null,
"nullable": true
},
"inputSelect": {
"type": "string",
"title": "Inputselect",
"default": null,
"nullable": true
},
"isValidView": {
"type": "boolean",
"title": "Isvalidview",
"default": null,
"nullable": true
}
}
}
HogQLMetadataResponseNullable
{
"type": "object",
"title": "HogQLMetadataResponse",
"default": null,
"nullable": true,
"required": [
"errors",
"notices",
"warnings"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Errors"
},
"isValid": {
"type": "boolean",
"title": "Isvalid",
"default": null,
"nullable": true
},
"notices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Notices"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Warnings"
},
"inputExpr": {
"type": "string",
"title": "Inputexpr",
"default": null,
"nullable": true
},
"inputSelect": {
"type": "string",
"title": "Inputselect",
"default": null,
"nullable": true
},
"isValidView": {
"type": "boolean",
"title": "Isvalidview",
"default": null,
"nullable": true
}
},
"description": "Query metadata output"
}
HogQLNotice
{
"type": "object",
"title": "HogQLNotice",
"required": [
"message"
],
"properties": {
"end": {
"type": "integer",
"title": "End",
"default": null,
"nullable": true
},
"fix": {
"type": "string",
"title": "Fix",
"default": null,
"nullable": true
},
"start": {
"type": "integer",
"title": "Start",
"default": null,
"nullable": true
},
"message": {
"type": "string",
"title": "Message"
}
}
}
HogQLPropertyFilter
{
"type": "object",
"title": "HogQLPropertyFilter",
"required": [
"key"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "hogql",
"title": "Type",
"default": "hogql"
},
"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
}
}
}
HogQLQuery
{
"type": "object",
"title": "HogQLQuery",
"required": [
"query"
],
"properties": {
"kind": {
"const": "HogQLQuery",
"title": "Kind",
"default": "HogQLQuery"
},
"query": {
"type": "string",
"title": "Query"
},
"values": {
"type": "object",
"title": "Values",
"default": null,
"nullable": true,
"description": "Constant values that can be referenced with the {placeholder} syntax in the query"
},
"explain": {
"type": "boolean",
"title": "Explain",
"default": null,
"nullable": true
},
"filters": {
"$ref": "#/components/schemas/HogQLFiltersNullable"
},
"response": {
"$ref": "#/components/schemas/HogQLQueryResponseNullable"
},
"modifiers": {
"$ref": "#/components/schemas/HogQLQueryModifiersNullable"
}
}
}
HogQLQueryModifiers
{
"type": "object",
"title": "HogQLQueryModifiers",
"properties": {
"inCohortVia": {
"$ref": "#/components/schemas/InCohortViaNullable"
},
"materializationMode": {
"$ref": "#/components/schemas/MaterializationModeNullable"
},
"personsOnEventsMode": {
"$ref": "#/components/schemas/PersonsOnEventsModeNullable"
},
"personsArgMaxVersion": {
"$ref": "#/components/schemas/PersonsArgMaxVersionNullable"
},
"dataWarehouseEventsModifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataWarehouseEventsModifier"
},
"title": "Datawarehouseeventsmodifiers",
"default": null,
"nullable": true
}
}
}
HogQLQueryModifiersNullable
{
"type": "object",
"title": "HogQLQueryModifiers",
"default": null,
"nullable": true,
"properties": {
"inCohortVia": {
"$ref": "#/components/schemas/InCohortViaNullable"
},
"materializationMode": {
"$ref": "#/components/schemas/MaterializationModeNullable"
},
"personsOnEventsMode": {
"$ref": "#/components/schemas/PersonsOnEventsModeNullable"
},
"personsArgMaxVersion": {
"$ref": "#/components/schemas/PersonsArgMaxVersionNullable"
},
"dataWarehouseEventsModifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataWarehouseEventsModifier"
},
"title": "Datawarehouseeventsmodifiers",
"default": null,
"nullable": true
}
},
"description": "Modifiers used when performing the query"
}
HogQLQueryResponse
{
"type": "object",
"title": "HogQLQueryResponse",
"properties": {
"error": {
"type": "string",
"title": "Error",
"default": null,
"nullable": true,
"description": "Query error. Returned only if 'explain' is true. Throws an error otherwise."
},
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true,
"description": "Generated HogQL query"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"query": {
"type": "string",
"title": "Query",
"default": null,
"nullable": true,
"description": "Input query string"
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true,
"description": "Types of returned columns"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true,
"description": "Returned columns"
},
"explain": {
"type": "array",
"items": {
"type": "string"
},
"title": "Explain",
"default": null,
"nullable": true,
"description": "Query explanation output"
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {},
"title": "Results",
"default": null,
"nullable": true,
"description": "Query results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true,
"description": "Measured timings for different parts of the query generation process"
},
"metadata": {
"$ref": "#/components/schemas/HogQLMetadataResponseNullable"
},
"modifiers": {
"$ref": "#/components/schemas/HogQLQueryModifiersNullable"
},
"clickhouse": {
"type": "string",
"title": "Clickhouse",
"default": null,
"nullable": true,
"description": "Executed ClickHouse query"
}
}
}
HogQLQueryResponseNullable
{
"type": "object",
"title": "HogQLQueryResponse",
"default": null,
"nullable": true,
"properties": {
"error": {
"type": "string",
"title": "Error",
"default": null,
"nullable": true,
"description": "Query error. Returned only if 'explain' is true. Throws an error otherwise."
},
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true,
"description": "Generated HogQL query"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"query": {
"type": "string",
"title": "Query",
"default": null,
"nullable": true,
"description": "Input query string"
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true,
"description": "Types of returned columns"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true,
"description": "Returned columns"
},
"explain": {
"type": "array",
"items": {
"type": "string"
},
"title": "Explain",
"default": null,
"nullable": true,
"description": "Query explanation output"
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {},
"title": "Results",
"default": null,
"nullable": true,
"description": "Query results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true,
"description": "Measured timings for different parts of the query generation process"
},
"metadata": {
"$ref": "#/components/schemas/HogQLMetadataResponseNullable"
},
"modifiers": {
"$ref": "#/components/schemas/HogQLQueryModifiersNullable"
},
"clickhouse": {
"type": "string",
"title": "Clickhouse",
"default": null,
"nullable": true,
"description": "Executed ClickHouse query"
}
},
"description": "Cached query response"
}