PostHog · Schema

MarketingAnalyticsAggregatedQuery

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
aggregation_group_type_index integer Groups aggregation - not used in Web Analytics but required for type compatibility
compareFilter object
conversionGoal object
dataColorTheme number Colors used in the insight's visualization - not used in Web Analytics but required for type compatibility
dateRange object
doPathCleaning boolean
draftConversionGoal object Draft conversion goal that can be set in the UI without saving
drillDownLevel object Drill-down hierarchy level: channel, source, or campaign (default)
filterTestAccounts boolean
includeRevenue boolean
integrationFilter object Filter by integration IDs
interval object Interval for date range calculation (affects date_to rounding for hour vs day ranges)
kind string
modifiers object Modifiers used when performing the query
properties array
response object
sampling object
samplingFactor number Sampling rate
select array Return a limited set of data. Will use default columns if empty.
tags object
useSessionsTable boolean
version number version of the node, used for schema migrations
View JSON Schema on GitHub

JSON Schema

posthog-marketinganalyticsaggregatedquery-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MarketingAnalyticsAggregatedQuery",
  "title": "MarketingAnalyticsAggregatedQuery",
  "additionalProperties": false,
  "properties": {
    "aggregation_group_type_index": {
      "default": null,
      "description": "Groups aggregation - not used in Web Analytics but required for type compatibility",
      "title": "Aggregation Group Type Index",
      "type": "integer",
      "nullable": true
    },
    "compareFilter": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/CompareFilter"
        }
      ],
      "nullable": true
    },
    "conversionGoal": {
      "default": null,
      "title": "Conversiongoal",
      "anyOf": [
        {
          "$ref": "#/components/schemas/ActionConversionGoal"
        },
        {
          "$ref": "#/components/schemas/CustomEventConversionGoal"
        }
      ],
      "nullable": true
    },
    "dataColorTheme": {
      "default": null,
      "description": "Colors used in the insight's visualization - not used in Web Analytics but required for type compatibility",
      "title": "Datacolortheme",
      "type": "number",
      "nullable": true
    },
    "dateRange": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/DateRange"
        }
      ],
      "nullable": true
    },
    "doPathCleaning": {
      "default": null,
      "title": "Dopathcleaning",
      "type": "boolean",
      "nullable": true
    },
    "draftConversionGoal": {
      "default": null,
      "description": "Draft conversion goal that can be set in the UI without saving",
      "title": "Draftconversiongoal",
      "anyOf": [
        {
          "$ref": "#/components/schemas/ConversionGoalFilter1"
        },
        {
          "$ref": "#/components/schemas/ConversionGoalFilter2"
        },
        {
          "$ref": "#/components/schemas/ConversionGoalFilter3"
        }
      ],
      "nullable": true
    },
    "drillDownLevel": {
      "default": null,
      "description": "Drill-down hierarchy level: channel, source, or campaign (default)",
      "allOf": [
        {
          "$ref": "#/components/schemas/MarketingAnalyticsDrillDownLevel"
        }
      ],
      "nullable": true
    },
    "filterTestAccounts": {
      "default": null,
      "title": "Filtertestaccounts",
      "type": "boolean",
      "nullable": true
    },
    "includeRevenue": {
      "default": null,
      "title": "Includerevenue",
      "type": "boolean",
      "nullable": true
    },
    "integrationFilter": {
      "default": null,
      "description": "Filter by integration IDs",
      "allOf": [
        {
          "$ref": "#/components/schemas/IntegrationFilter"
        }
      ],
      "nullable": true
    },
    "interval": {
      "default": null,
      "description": "Interval for date range calculation (affects date_to rounding for hour vs day ranges)",
      "allOf": [
        {
          "$ref": "#/components/schemas/IntervalType"
        }
      ],
      "nullable": true
    },
    "kind": {
      "default": "MarketingAnalyticsAggregatedQuery",
      "title": "Kind",
      "type": "string",
      "enum": [
        "MarketingAnalyticsAggregatedQuery"
      ]
    },
    "modifiers": {
      "default": null,
      "description": "Modifiers used when performing the query",
      "allOf": [
        {
          "$ref": "#/components/schemas/HogQLQueryModifiers"
        }
      ],
      "nullable": true
    },
    "properties": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/EventPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/PersonPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/SessionPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/CohortPropertyFilter"
          }
        ]
      },
      "title": "Properties"
    },
    "response": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/MarketingAnalyticsAggregatedQueryResponse"
        }
      ],
      "nullable": true
    },
    "sampling": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/WebAnalyticsSampling"
        }
      ],
      "nullable": true
    },
    "samplingFactor": {
      "default": null,
      "description": "Sampling rate",
      "title": "Samplingfactor",
      "type": "number",
      "nullable": true
    },
    "select": {
      "default": null,
      "description": "Return a limited set of data. Will use default columns if empty.",
      "title": "Select",
      "items": {
        "type": "string"
      },
      "type": "array",
      "nullable": true
    },
    "tags": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryLogTags"
        }
      ],
      "nullable": true
    },
    "useSessionsTable": {
      "default": null,
      "title": "Usesessionstable",
      "type": "boolean",
      "nullable": true
    },
    "version": {
      "default": null,
      "description": "version of the node, used for schema migrations",
      "title": "Version",
      "type": "number",
      "nullable": true
    }
  },
  "required": [
    "properties"
  ],
  "type": "object"
}