PostHog · Schema

HogQLQueryModifiers

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
bounceRateDurationSeconds number
bounceRatePageViewMode object
convertToProjectTimezone boolean
customChannelTypeRules array
dataWarehouseEventsModifiers array
debug boolean
forceClickhouseDataSkippingIndexes array If these are provided, the query will fail if these skip indexes are not used
formatCsvAllowDoubleQuotes boolean
inCohortVia object
inlineCohortCalculation object
materializationMode object
materializedColumnsOptimizationMode object
optimizeJoinedFilters boolean
optimizeProjections boolean
personsArgMaxVersion object
personsJoinMode object
personsOnEventsMode object
propertyGroupsMode object
s3TableUseInvalidColumns boolean
sessionIdPushdown boolean Push a `session_id_v7 IN (SELECT … FROM events WHERE …)` predicate into the raw_sessions subquery to limit aggregation to sessions that participate in the outer events filter.
sessionTableVersion object
sessionsV2JoinMode object
timings boolean
useMaterializedViews boolean
usePreaggregatedIntermediateResults boolean
usePreaggregatedTableTransforms boolean Try to automatically convert HogQL queries to use preaggregated tables at the AST level *
useWebAnalyticsPreAggregatedTables boolean
View JSON Schema on GitHub

JSON Schema

posthog-hogqlquerymodifiers-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HogQLQueryModifiers",
  "title": "HogQLQueryModifiers",
  "additionalProperties": false,
  "properties": {
    "bounceRateDurationSeconds": {
      "default": null,
      "title": "Bounceratedurationseconds",
      "type": "number",
      "nullable": true
    },
    "bounceRatePageViewMode": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/BounceRatePageViewMode"
        }
      ],
      "nullable": true
    },
    "convertToProjectTimezone": {
      "default": null,
      "title": "Converttoprojecttimezone",
      "type": "boolean",
      "nullable": true
    },
    "customChannelTypeRules": {
      "default": null,
      "title": "Customchanneltyperules",
      "items": {
        "$ref": "#/components/schemas/CustomChannelRule"
      },
      "type": "array",
      "nullable": true
    },
    "dataWarehouseEventsModifiers": {
      "default": null,
      "title": "Datawarehouseeventsmodifiers",
      "items": {
        "$ref": "#/components/schemas/DataWarehouseEventsModifier"
      },
      "type": "array",
      "nullable": true
    },
    "debug": {
      "default": null,
      "title": "Debug",
      "type": "boolean",
      "nullable": true
    },
    "forceClickhouseDataSkippingIndexes": {
      "default": null,
      "description": "If these are provided, the query will fail if these skip indexes are not used",
      "title": "Forceclickhousedataskippingindexes",
      "items": {
        "type": "string"
      },
      "type": "array",
      "nullable": true
    },
    "formatCsvAllowDoubleQuotes": {
      "default": null,
      "title": "Formatcsvallowdoublequotes",
      "type": "boolean",
      "nullable": true
    },
    "inCohortVia": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/InCohortVia"
        }
      ],
      "nullable": true
    },
    "inlineCohortCalculation": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/InlineCohortCalculation"
        }
      ],
      "nullable": true
    },
    "materializationMode": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/MaterializationMode"
        }
      ],
      "nullable": true
    },
    "materializedColumnsOptimizationMode": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/MaterializedColumnsOptimizationMode"
        }
      ],
      "nullable": true
    },
    "optimizeJoinedFilters": {
      "default": null,
      "title": "Optimizejoinedfilters",
      "type": "boolean",
      "nullable": true
    },
    "optimizeProjections": {
      "default": null,
      "title": "Optimizeprojections",
      "type": "boolean",
      "nullable": true
    },
    "personsArgMaxVersion": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/PersonsArgMaxVersion"
        }
      ],
      "nullable": true
    },
    "personsJoinMode": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/PersonsJoinMode"
        }
      ],
      "nullable": true
    },
    "personsOnEventsMode": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/PersonsOnEventsMode"
        }
      ],
      "nullable": true
    },
    "propertyGroupsMode": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/PropertyGroupsMode"
        }
      ],
      "nullable": true
    },
    "s3TableUseInvalidColumns": {
      "default": null,
      "title": "S3Tableuseinvalidcolumns",
      "type": "boolean",
      "nullable": true
    },
    "sessionIdPushdown": {
      "default": null,
      "description": "Push a `session_id_v7 IN (SELECT \u2026 FROM events WHERE \u2026)` predicate into the raw_sessions subquery to limit aggregation to sessions that participate in the outer events filter.",
      "title": "Sessionidpushdown",
      "type": "boolean",
      "nullable": true
    },
    "sessionTableVersion": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/SessionTableVersion"
        }
      ],
      "nullable": true
    },
    "sessionsV2JoinMode": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/SessionsV2JoinMode"
        }
      ],
      "nullable": true
    },
    "timings": {
      "default": null,
      "title": "Timings",
      "type": "boolean",
      "nullable": true
    },
    "useMaterializedViews": {
      "default": null,
      "title": "Usematerializedviews",
      "type": "boolean",
      "nullable": true
    },
    "usePreaggregatedIntermediateResults": {
      "default": null,
      "title": "Usepreaggregatedintermediateresults",
      "type": "boolean",
      "nullable": true
    },
    "usePreaggregatedTableTransforms": {
      "default": null,
      "description": "Try to automatically convert HogQL queries to use preaggregated tables at the AST level *",
      "title": "Usepreaggregatedtabletransforms",
      "type": "boolean",
      "nullable": true
    },
    "useWebAnalyticsPreAggregatedTables": {
      "default": null,
      "title": "Usewebanalyticspreaggregatedtables",
      "type": "boolean",
      "nullable": true
    }
  },
  "type": "object"
}