PostHog · Schema

HogQLAutocomplete

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
connectionId string Optional direct external data source id for running against a specific source
endPosition integer End position of the editor word
filters object Table to validate the expression against
globals object Global values in scope
kind string
language object Language to validate
modifiers object Modifiers used when performing the query
query string Query to validate
response object
sourceQuery object Query in whose context to validate.
startPosition integer Start position of the editor word
tags object
version number version of the node, used for schema migrations
View JSON Schema on GitHub

JSON Schema

posthog-hogqlautocomplete-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HogQLAutocomplete",
  "title": "HogQLAutocomplete",
  "additionalProperties": false,
  "properties": {
    "connectionId": {
      "default": null,
      "description": "Optional direct external data source id for running against a specific source",
      "title": "Connectionid",
      "type": "string",
      "nullable": true
    },
    "endPosition": {
      "description": "End position of the editor word",
      "title": "Endposition",
      "type": "integer"
    },
    "filters": {
      "default": null,
      "description": "Table to validate the expression against",
      "allOf": [
        {
          "$ref": "#/components/schemas/HogQLFilters"
        }
      ],
      "nullable": true
    },
    "globals": {
      "default": null,
      "description": "Global values in scope",
      "title": "Globals",
      "additionalProperties": true,
      "type": "object",
      "nullable": true
    },
    "kind": {
      "default": "HogQLAutocomplete",
      "title": "Kind",
      "type": "string",
      "enum": [
        "HogQLAutocomplete"
      ]
    },
    "language": {
      "description": "Language to validate",
      "allOf": [
        {
          "$ref": "#/components/schemas/HogLanguage"
        }
      ]
    },
    "modifiers": {
      "default": null,
      "description": "Modifiers used when performing the query",
      "allOf": [
        {
          "$ref": "#/components/schemas/HogQLQueryModifiers"
        }
      ],
      "nullable": true
    },
    "query": {
      "description": "Query to validate",
      "title": "Query",
      "type": "string"
    },
    "response": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/HogQLAutocompleteResponse"
        }
      ],
      "nullable": true
    },
    "sourceQuery": {
      "default": null,
      "description": "Query in whose context to validate.",
      "title": "Sourcequery",
      "anyOf": [
        {
          "$ref": "#/components/schemas/EventsNode"
        },
        {
          "$ref": "#/components/schemas/ActionsNode"
        },
        {
          "$ref": "#/components/schemas/PersonsNode"
        },
        {
          "$ref": "#/components/schemas/EventsQuery"
        },
        {
          "$ref": "#/components/schemas/SessionsQuery"
        },
        {
          "$ref": "#/components/schemas/ActorsQuery"
        },
        {
          "$ref": "#/components/schemas/GroupsQuery"
        },
        {
          "$ref": "#/components/schemas/InsightActorsQuery"
        },
        {
          "$ref": "#/components/schemas/InsightActorsQueryOptions"
        },
        {
          "$ref": "#/components/schemas/SessionsTimelineQuery"
        },
        {
          "$ref": "#/components/schemas/HogQuery"
        },
        {
          "$ref": "#/components/schemas/HogQLQuery"
        },
        {
          "$ref": "#/components/schemas/HogQLMetadata"
        },
        {
          "$ref": "#/components/schemas/HogQLAutocomplete"
        },
        {
          "$ref": "#/components/schemas/RevenueAnalyticsGrossRevenueQuery"
        },
        {
          "$ref": "#/components/schemas/RevenueAnalyticsMetricsQuery"
        },
        {
          "$ref": "#/components/schemas/RevenueAnalyticsMRRQuery"
        },
        {
          "$ref": "#/components/schemas/RevenueAnalyticsOverviewQuery"
        },
        {
          "$ref": "#/components/schemas/RevenueAnalyticsTopCustomersQuery"
        },
        {
          "$ref": "#/components/schemas/MarketingAnalyticsTableQuery"
        },
        {
          "$ref": "#/components/schemas/MarketingAnalyticsAggregatedQuery"
        },
        {
          "$ref": "#/components/schemas/NonIntegratedConversionsTableQuery"
        },
        {
          "$ref": "#/components/schemas/WebOverviewQuery"
        },
        {
          "$ref": "#/components/schemas/WebStatsTableQuery"
        },
        {
          "$ref": "#/components/schemas/WebExternalClicksTableQuery"
        },
        {
          "$ref": "#/components/schemas/WebGoalsQuery"
        },
        {
          "$ref": "#/components/schemas/WebVitalsQuery"
        },
        {
          "$ref": "#/components/schemas/WebVitalsPathBreakdownQuery"
        },
        {
          "$ref": "#/components/schemas/WebPageURLSearchQuery"
        },
        {
          "$ref": "#/components/schemas/WebTrendsQuery"
        },
        {
          "$ref": "#/components/schemas/WebAnalyticsExternalSummaryQuery"
        },
        {
          "$ref": "#/components/schemas/WebNotableChangesQuery"
        },
        {
          "$ref": "#/components/schemas/SessionAttributionExplorerQuery"
        },
        {
          "$ref": "#/components/schemas/RevenueExampleEventsQuery"
        },
        {
          "$ref": "#/components/schemas/RevenueExampleDataWarehouseTablesQuery"
        },
        {
          "$ref": "#/components/schemas/ErrorTrackingQuery"
        },
        {
          "$ref": "#/components/schemas/ErrorTrackingSimilarIssuesQuery"
        },
        {
          "$ref": "#/components/schemas/ErrorTrackingBreakdownsQuery"
        },
        {
          "$ref": "#/components/schemas/ErrorTrackingIssueCorrelationQuery"
        },
        {
          "$ref": "#/components/schemas/LogsQuery"
        },
        {
          "$ref": "#/components/schemas/LogAttributesQuery"
        },
        {
          "$ref": "#/components/schemas/LogValuesQuery"
        },
        {
          "$ref": "#/components/schemas/TraceSpansQuery"
        },
        {
          "$ref": "#/components/schemas/ExperimentFunnelsQuery"
        },
        {
          "$ref": "#/components/schemas/ExperimentTrendsQuery"
        },
        {
          "$ref": "#/components/schemas/CalendarHeatmapQuery"
        },
        {
          "$ref": "#/components/schemas/RecordingsQuery"
        },
        {
          "$ref": "#/components/schemas/TracesQuery"
        },
        {
          "$ref": "#/components/schemas/TraceQuery"
        },
        {
          "$ref": "#/components/schemas/TraceNeighborsQuery"
        },
        {
          "$ref": "#/components/schemas/VectorSearchQuery"
        },
        {
          "$ref": "#/components/schemas/UsageMetricsQuery"
        },
        {
          "$ref": "#/components/schemas/EndpointsUsageOverviewQuery"
        },
        {
          "$ref": "#/components/schemas/EndpointsUsageTableQuery"
        },
        {
          "$ref": "#/components/schemas/EndpointsUsageTrendsQuery"
        }
      ],
      "nullable": true
    },
    "startPosition": {
      "description": "Start position of the editor word",
      "title": "Startposition",
      "type": "integer"
    },
    "tags": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryLogTags"
        }
      ],
      "nullable": true
    },
    "version": {
      "default": null,
      "description": "version of the node, used for schema migrations",
      "title": "Version",
      "type": "number",
      "nullable": true
    }
  },
  "required": [
    "endPosition",
    "language",
    "query",
    "startPosition"
  ],
  "type": "object"
}