PostHog · Schema

UsageMetricsQuery

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
group_key string Group key. Required with group_type_index for group queries.
group_type_index integer Group type index. Required with group_key for group queries.
kind string
modifiers object Modifiers used when performing the query
person_id string Person ID to fetch metrics for. Mutually exclusive with group parameters.
response object
tags object
version number version of the node, used for schema migrations
View JSON Schema on GitHub

JSON Schema

posthog-usagemetricsquery-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UsageMetricsQuery",
  "title": "UsageMetricsQuery",
  "additionalProperties": false,
  "properties": {
    "group_key": {
      "default": null,
      "description": "Group key. Required with group_type_index for group queries.",
      "title": "Group Key",
      "type": "string",
      "nullable": true
    },
    "group_type_index": {
      "default": null,
      "description": "Group type index. Required with group_key for group queries.",
      "title": "Group Type Index",
      "type": "integer",
      "nullable": true
    },
    "kind": {
      "default": "UsageMetricsQuery",
      "title": "Kind",
      "type": "string",
      "enum": [
        "UsageMetricsQuery"
      ]
    },
    "modifiers": {
      "default": null,
      "description": "Modifiers used when performing the query",
      "allOf": [
        {
          "$ref": "#/components/schemas/HogQLQueryModifiers"
        }
      ],
      "nullable": true
    },
    "person_id": {
      "default": null,
      "description": "Person ID to fetch metrics for. Mutually exclusive with group parameters.",
      "title": "Person Id",
      "type": "string",
      "nullable": true
    },
    "response": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/UsageMetricsQueryResponse"
        }
      ],
      "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
    }
  },
  "type": "object"
}