PostHog · Schema

PathsFilter

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
edgeLimit	integer
endPoint	string
excludeEvents	array
includeEventTypes	array
localPathCleaningFilters	array
maxEdgeWeight	integer
minEdgeWeight	integer
pathDropoffKey	string	Relevant only within actors query
pathEndKey	string	Relevant only within actors query
pathGroupings	array
pathReplacements	boolean
pathStartKey	string	Relevant only within actors query
pathsHogQLExpression	string
showFullUrls	boolean
startPoint	string
stepLimit	integer

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PathsFilter",
  "title": "PathsFilter",
  "additionalProperties": false,
  "properties": {
    "edgeLimit": {
      "default": 50,
      "title": "Edgelimit",
      "type": "integer",
      "nullable": true
    },
    "endPoint": {
      "default": null,
      "title": "Endpoint",
      "type": "string",
      "nullable": true
    },
    "excludeEvents": {
      "default": null,
      "title": "Excludeevents",
      "items": {
        "type": "string"
      },
      "type": "array",
      "nullable": true
    },
    "includeEventTypes": {
      "default": null,
      "title": "Includeeventtypes",
      "items": {
        "$ref": "#/components/schemas/PathType"
      },
      "type": "array",
      "nullable": true
    },
    "localPathCleaningFilters": {
      "default": null,
      "title": "Localpathcleaningfilters",
      "items": {
        "$ref": "#/components/schemas/PathCleaningFilter"
      },
      "type": "array",
      "nullable": true
    },
    "maxEdgeWeight": {
      "default": null,
      "title": "Maxedgeweight",
      "type": "integer",
      "nullable": true
    },
    "minEdgeWeight": {
      "default": null,
      "title": "Minedgeweight",
      "type": "integer",
      "nullable": true
    },
    "pathDropoffKey": {
      "default": null,
      "description": "Relevant only within actors query",
      "title": "Pathdropoffkey",
      "type": "string",
      "nullable": true
    },
    "pathEndKey": {
      "default": null,
      "description": "Relevant only within actors query",
      "title": "Pathendkey",
      "type": "string",
      "nullable": true
    },
    "pathGroupings": {
      "default": null,
      "title": "Pathgroupings",
      "items": {
        "type": "string"
      },
      "type": "array",
      "nullable": true
    },
    "pathReplacements": {
      "default": null,
      "title": "Pathreplacements",
      "type": "boolean",
      "nullable": true
    },
    "pathStartKey": {
      "default": null,
      "description": "Relevant only within actors query",
      "title": "Pathstartkey",
      "type": "string",
      "nullable": true
    },
    "pathsHogQLExpression": {
      "default": null,
      "title": "Pathshogqlexpression",
      "type": "string",
      "nullable": true
    },
    "showFullUrls": {
      "default": null,
      "title": "Showfullurls",
      "type": "boolean",
      "nullable": true
    },
    "startPoint": {
      "default": null,
      "title": "Startpoint",
      "type": "string",
      "nullable": true
    },
    "stepLimit": {
      "default": 5,
      "title": "Steplimit",
      "type": "integer",
      "nullable": true
    }
  },
  "type": "object"
}