PostHog · Schema

GroupsQuery

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
group_type_index	integer
kind	string
limit	integer
modifiers	object	Modifiers used when performing the query
offset	integer
orderBy	array
properties	array
response	object
search	string
select	array
tags	object
version	number	version of the node, used for schema migrations

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GroupsQuery",
  "title": "GroupsQuery",
  "additionalProperties": false,
  "properties": {
    "group_type_index": {
      "title": "Group Type Index",
      "type": "integer"
    },
    "kind": {
      "default": "GroupsQuery",
      "title": "Kind",
      "type": "string",
      "enum": [
        "GroupsQuery"
      ]
    },
    "limit": {
      "default": null,
      "title": "Limit",
      "type": "integer",
      "nullable": true
    },
    "modifiers": {
      "default": null,
      "description": "Modifiers used when performing the query",
      "allOf": [
        {
          "$ref": "#/components/schemas/HogQLQueryModifiers"
        }
      ],
      "nullable": true
    },
    "offset": {
      "default": null,
      "title": "Offset",
      "type": "integer",
      "nullable": true
    },
    "orderBy": {
      "default": null,
      "title": "Orderby",
      "items": {
        "type": "string"
      },
      "type": "array",
      "nullable": true
    },
    "properties": {
      "default": null,
      "title": "Properties",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/GroupPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/HogQLPropertyFilter"
          }
        ]
      },
      "type": "array",
      "nullable": true
    },
    "response": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupsQueryResponse"
        }
      ],
      "nullable": true
    },
    "search": {
      "default": null,
      "title": "Search",
      "type": "string",
      "nullable": true
    },
    "select": {
      "default": null,
      "title": "Select",
      "items": {
        "type": "string"
      },
      "type": "array",
      "nullable": true
    },
    "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": [
    "group_type_index"
  ],
  "type": "object"
}