PostHog · Schema

Cohort

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
id	integer
name	string
description	string
groups	object
deleted	boolean
filters	object
query	object
version	integer
pending_version	integer
is_calculating	boolean
created_by	object
created_at	string
last_calculation	string
last_backfill_person_properties_at	string
errors_calculating	integer
last_error_message	string
count	integer
is_static	boolean
cohort_type	object	Type of cohort based on filter complexity * `static` - static * `person_property` - person_property * `behavioral` - behavioral * `realtime` - realtime * `analytical` - analytical
experiment_set	array
_create_in_folder	string
_create_static_person_ids	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Cohort",
  "title": "Cohort",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "description": {
      "type": "string",
      "maxLength": 1000
    },
    "groups": {},
    "deleted": {
      "type": "boolean"
    },
    "filters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CohortFilters"
        }
      ],
      "nullable": true
    },
    "query": {
      "nullable": true
    },
    "version": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "pending_version": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "is_calculating": {
      "type": "boolean",
      "readOnly": true
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserBasic"
        }
      ],
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "nullable": true
    },
    "last_calculation": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "nullable": true
    },
    "last_backfill_person_properties_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "nullable": true
    },
    "errors_calculating": {
      "type": "integer",
      "readOnly": true
    },
    "last_error_message": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "count": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "is_static": {
      "type": "boolean"
    },
    "cohort_type": {
      "nullable": true,
      "description": "Type of cohort based on filter complexity\n\n* `static` - static\n* `person_property` - person_property\n* `behavioral` - behavioral\n* `realtime` - realtime\n* `analytical` - analytical",
      "oneOf": [
        {
          "$ref": "#/components/schemas/CohortTypeEnum"
        },
        {
          "$ref": "#/components/schemas/BlankEnum"
        },
        {
          "$ref": "#/components/schemas/NullEnum"
        }
      ]
    },
    "experiment_set": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "readOnly": true
    },
    "_create_in_folder": {
      "type": "string",
      "writeOnly": true,
      "title": " create in folder"
    },
    "_create_static_person_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "writeOnly": true,
      "default": [],
      "title": " create static person ids"
    }
  },
  "required": [
    "count",
    "created_at",
    "created_by",
    "errors_calculating",
    "experiment_set",
    "id",
    "is_calculating",
    "last_backfill_person_properties_at",
    "last_calculation",
    "last_error_message",
    "pending_version",
    "version"
  ]
}