PostHog · Schema

EndpointsUsageTrendsQuery

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
breakdownBy	object	Optional breakdown for stacked charts
compareFilter	object	Compare to previous period
dateRange	object
endpointNames	array	Filter to specific endpoints by name
interval	object	Time interval
kind	string
materializationType	object	Filter by materialization type
metric	object	Metric to trend
modifiers	object	Modifiers used when performing the query
response	object
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/EndpointsUsageTrendsQuery",
  "title": "EndpointsUsageTrendsQuery",
  "additionalProperties": false,
  "properties": {
    "breakdownBy": {
      "default": null,
      "description": "Optional breakdown for stacked charts",
      "allOf": [
        {
          "$ref": "#/components/schemas/EndpointsUsageBreakdown"
        }
      ],
      "nullable": true
    },
    "compareFilter": {
      "default": null,
      "description": "Compare to previous period",
      "allOf": [
        {
          "$ref": "#/components/schemas/CompareFilter"
        }
      ],
      "nullable": true
    },
    "dateRange": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/DateRange"
        }
      ],
      "nullable": true
    },
    "endpointNames": {
      "default": null,
      "description": "Filter to specific endpoints by name",
      "title": "Endpointnames",
      "items": {
        "type": "string"
      },
      "type": "array",
      "nullable": true
    },
    "interval": {
      "default": null,
      "description": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/IntervalType"
        }
      ],
      "nullable": true
    },
    "kind": {
      "default": "EndpointsUsageTrendsQuery",
      "title": "Kind",
      "type": "string",
      "enum": [
        "EndpointsUsageTrendsQuery"
      ]
    },
    "materializationType": {
      "default": null,
      "description": "Filter by materialization type",
      "allOf": [
        {
          "$ref": "#/components/schemas/MaterializationType"
        }
      ],
      "nullable": true
    },
    "metric": {
      "description": "Metric to trend",
      "allOf": [
        {
          "$ref": "#/components/schemas/Metric"
        }
      ]
    },
    "modifiers": {
      "default": null,
      "description": "Modifiers used when performing the query",
      "allOf": [
        {
          "$ref": "#/components/schemas/HogQLQueryModifiers"
        }
      ],
      "nullable": true
    },
    "response": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/EndpointsUsageTrendsQueryResponse"
        }
      ],
      "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": [
    "metric"
  ],
  "type": "object"
}