PostHog · Schema

PatchedSessionRecordingPlaylist

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
id	integer
short_id	string
name	string	Human-readable name for the playlist.
derived_name	string
description	string	Optional description of the playlist's purpose or contents.
pinned	boolean	Whether this playlist is pinned to the top of the list.
created_at	string
created_by	object
deleted	boolean	Set to true to soft-delete the playlist.
filters	object	JSON object with recording filter criteria. Only used when type is 'filters'. Defines which recordings match this saved filter view. When updating a filters-type playlist, you must include the existin
last_modified_at	string
last_modified_by	object
recordings_counts	object
type	object	Playlist type: 'collection' for manually curated recordings, 'filters' for saved filter views. Required on create, cannot be changed after. * `collection` - Collection * `filters` - Filters
is_synthetic	boolean	Return whether this is a synthetic playlist
_create_in_folder	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PatchedSessionRecordingPlaylist",
  "title": "PatchedSessionRecordingPlaylist",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "short_id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "nullable": true,
      "description": "Human-readable name for the playlist.",
      "maxLength": 400
    },
    "derived_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "description": {
      "type": "string",
      "description": "Optional description of the playlist's purpose or contents."
    },
    "pinned": {
      "type": "boolean",
      "description": "Whether this playlist is pinned to the top of the list."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserBasic"
        }
      ],
      "readOnly": true
    },
    "deleted": {
      "type": "boolean",
      "description": "Set to true to soft-delete the playlist."
    },
    "filters": {
      "description": "JSON object with recording filter criteria. Only used when type is 'filters'. Defines which recordings match this saved filter view. When updating a filters-type playlist, you must include the existing filters alongside any other changes \u2014 omitting filters will be treated as removing them."
    },
    "last_modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "last_modified_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserBasic"
        }
      ],
      "readOnly": true
    },
    "recordings_counts": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "additionalProperties": {
          "oneOf": [
            {
              "type": "integer"
            },
            {
              "type": "boolean"
            }
          ],
          "nullable": true
        }
      },
      "readOnly": true
    },
    "type": {
      "nullable": true,
      "description": "Playlist type: 'collection' for manually curated recordings, 'filters' for saved filter views. Required on create, cannot be changed after.\n\n* `collection` - Collection\n* `filters` - Filters",
      "oneOf": [
        {
          "$ref": "#/components/schemas/SessionRecordingPlaylistTypeEnum"
        },
        {
          "$ref": "#/components/schemas/NullEnum"
        }
      ]
    },
    "is_synthetic": {
      "type": "boolean",
      "description": "Return whether this is a synthetic playlist",
      "readOnly": true
    },
    "_create_in_folder": {
      "type": "string",
      "writeOnly": true,
      "title": " create in folder"
    }
  }
}