PostHog · Schema

LogsQuery

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
after string Cursor for fetching the next page of results
dateRange object
filterGroup object
kind string
limit integer
liveLogsCheckpoint string
modifiers object Modifiers used when performing the query
offset integer
orderBy object
resourceFingerprint string
response object
searchTerm string
serviceNames array
severityLevels array
sparklineBreakdownBy object Field to break down sparkline data by (used only by sparkline endpoint)
tags object
version number version of the node, used for schema migrations
View JSON Schema on GitHub

JSON Schema

posthog-logsquery-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LogsQuery",
  "title": "LogsQuery",
  "additionalProperties": false,
  "properties": {
    "after": {
      "default": null,
      "description": "Cursor for fetching the next page of results",
      "title": "After",
      "type": "string",
      "nullable": true
    },
    "dateRange": {
      "$ref": "#/components/schemas/DateRange"
    },
    "filterGroup": {
      "$ref": "#/components/schemas/PropertyGroupFilter"
    },
    "kind": {
      "default": "LogsQuery",
      "title": "Kind",
      "type": "string",
      "enum": [
        "LogsQuery"
      ]
    },
    "limit": {
      "default": null,
      "title": "Limit",
      "type": "integer",
      "nullable": true
    },
    "liveLogsCheckpoint": {
      "default": null,
      "title": "Livelogscheckpoint",
      "type": "string",
      "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,
      "allOf": [
        {
          "$ref": "#/components/schemas/LogsOrderBy"
        }
      ],
      "nullable": true
    },
    "resourceFingerprint": {
      "default": null,
      "title": "Resourcefingerprint",
      "type": "string",
      "nullable": true
    },
    "response": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/LogsQueryResponse"
        }
      ],
      "nullable": true
    },
    "searchTerm": {
      "default": null,
      "title": "Searchterm",
      "type": "string",
      "nullable": true
    },
    "serviceNames": {
      "items": {
        "type": "string"
      },
      "title": "Servicenames",
      "type": "array"
    },
    "severityLevels": {
      "items": {
        "$ref": "#/components/schemas/LogSeverityLevel"
      },
      "title": "Severitylevels",
      "type": "array"
    },
    "sparklineBreakdownBy": {
      "default": null,
      "description": "Field to break down sparkline data by (used only by sparkline endpoint)",
      "allOf": [
        {
          "$ref": "#/components/schemas/LogsSparklineBreakdownBy"
        }
      ],
      "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": [
    "dateRange",
    "filterGroup",
    "serviceNames",
    "severityLevels"
  ],
  "type": "object"
}