PostHog · Schema

QueryStatus

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
complete	boolean	Whether the query is still running. Will be true if the query is complete, even if it errored. Either result or error will be set.
dashboard_id	integer
end_time	string	When did the query execution task finish (whether successfully or not).
error	boolean	If the query failed, this will be set to true. More information can be found in the error_message field.
error_message	string
expiration_time	string
id	string
insight_id	integer
labels	array
pickup_time	string	When was the query execution task picked up by a worker.
query_async	boolean	ONLY async queries use QueryStatus.
query_progress	object
results	object
start_time	string	When was query execution task enqueued.
task_id	string
team_id	integer

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/QueryStatus",
  "title": "QueryStatus",
  "additionalProperties": false,
  "properties": {
    "complete": {
      "default": false,
      "description": "Whether the query is still running. Will be true if the query is complete, even if it errored. Either result or error will be set.",
      "title": "Complete",
      "type": "boolean",
      "nullable": true
    },
    "dashboard_id": {
      "default": null,
      "title": "Dashboard Id",
      "type": "integer",
      "nullable": true
    },
    "end_time": {
      "default": null,
      "description": "When did the query execution task finish (whether successfully or not).",
      "title": "End Time",
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "error": {
      "default": false,
      "description": "If the query failed, this will be set to true. More information can be found in the error_message field.",
      "title": "Error",
      "type": "boolean",
      "nullable": true
    },
    "error_message": {
      "default": null,
      "title": "Error Message",
      "type": "string",
      "nullable": true
    },
    "expiration_time": {
      "default": null,
      "title": "Expiration Time",
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "id": {
      "title": "Id",
      "type": "string"
    },
    "insight_id": {
      "default": null,
      "title": "Insight Id",
      "type": "integer",
      "nullable": true
    },
    "labels": {
      "default": null,
      "title": "Labels",
      "items": {
        "type": "string"
      },
      "type": "array",
      "nullable": true
    },
    "pickup_time": {
      "default": null,
      "description": "When was the query execution task picked up by a worker.",
      "title": "Pickup Time",
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "query_async": {
      "default": true,
      "description": "ONLY async queries use QueryStatus.",
      "title": "Query Async",
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "query_progress": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/ClickhouseQueryProgress"
        }
      ],
      "nullable": true
    },
    "results": {
      "default": null,
      "title": "Results",
      "nullable": true
    },
    "start_time": {
      "default": null,
      "description": "When was query execution task enqueued.",
      "title": "Start Time",
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "task_id": {
      "default": null,
      "title": "Task Id",
      "type": "string",
      "nullable": true
    },
    "team_id": {
      "title": "Team Id",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "team_id"
  ],
  "type": "object"
}