PostHog · Schema

VectorSearchQueryResponse

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
error	string	Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise.
hogql	string	Generated HogQL query.
modifiers	object	Modifiers used when performing the query
query_status	object	Query status indicates whether next to the provided data, a query is still running.
resolved_date_range	object	The date range used for the query
results	array
timings	array	Measured timings for different parts of the query generation process

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VectorSearchQueryResponse",
  "title": "VectorSearchQueryResponse",
  "additionalProperties": false,
  "properties": {
    "error": {
      "default": null,
      "description": "Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise.",
      "title": "Error",
      "type": "string",
      "nullable": true
    },
    "hogql": {
      "default": null,
      "description": "Generated HogQL query.",
      "title": "Hogql",
      "type": "string",
      "nullable": true
    },
    "modifiers": {
      "default": null,
      "description": "Modifiers used when performing the query",
      "allOf": [
        {
          "$ref": "#/components/schemas/HogQLQueryModifiers"
        }
      ],
      "nullable": true
    },
    "query_status": {
      "default": null,
      "description": "Query status indicates whether next to the provided data, a query is still running.",
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryStatus"
        }
      ],
      "nullable": true
    },
    "resolved_date_range": {
      "default": null,
      "description": "The date range used for the query",
      "allOf": [
        {
          "$ref": "#/components/schemas/ResolvedDateRangeResponse"
        }
      ],
      "nullable": true
    },
    "results": {
      "items": {
        "$ref": "#/components/schemas/VectorSearchResponseItem"
      },
      "title": "Results",
      "type": "array"
    },
    "timings": {
      "default": null,
      "description": "Measured timings for different parts of the query generation process",
      "title": "Timings",
      "items": {
        "$ref": "#/components/schemas/QueryTiming"
      },
      "type": "array",
      "nullable": true
    }
  },
  "required": [
    "results"
  ],
  "type": "object"
}