PostHog · Schema

EndpointRunResponse

Response from executing an endpoint query.

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
name string URL-safe endpoint name that was executed.
results array Query result rows. Each row is a list of values matching the columns order.
columns array Column names from the query SELECT clause.
hasMore boolean Whether more results are available beyond the limit.
endpoint_version integer Version number of the endpoint that was executed.
View JSON Schema on GitHub

JSON Schema

posthog-endpointrunresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EndpointRunResponse",
  "title": "EndpointRunResponse",
  "type": "object",
  "description": "Response from executing an endpoint query.",
  "properties": {
    "name": {
      "type": "string",
      "description": "URL-safe endpoint name that was executed."
    },
    "results": {
      "type": "array",
      "items": {},
      "description": "Query result rows. Each row is a list of values matching the columns order."
    },
    "columns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Column names from the query SELECT clause."
    },
    "hasMore": {
      "type": "boolean",
      "description": "Whether more results are available beyond the limit."
    },
    "endpoint_version": {
      "type": "integer",
      "description": "Version number of the endpoint that was executed."
    }
  },
  "required": [
    "name"
  ]
}