PostHog · Schema

SessionRecording

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
id	string
distinct_id	string
viewed	boolean
viewers	array
recording_duration	integer
active_seconds	integer
inactive_seconds	integer
start_time	string
end_time	string
click_count	integer
keypress_count	integer
mouse_activity_count	integer
console_log_count	integer
console_warn_count	integer
console_error_count	integer
start_url	string
person	object
retention_period_days	integer
expiry_time	string
recording_ttl	integer
snapshot_source	string
snapshot_library	string
ongoing	boolean
activity_score	number
has_summary	boolean
summary_outcome	object
external_references	array	Load external references (linked issues) for this recording

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SessionRecording",
  "title": "SessionRecording",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "distinct_id": {
      "type": "string",
      "readOnly": true,
      "nullable": true
    },
    "viewed": {
      "type": "boolean",
      "readOnly": true
    },
    "viewers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "readOnly": true
    },
    "recording_duration": {
      "type": "integer",
      "readOnly": true
    },
    "active_seconds": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "inactive_seconds": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "nullable": true
    },
    "end_time": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "nullable": true
    },
    "click_count": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "keypress_count": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "mouse_activity_count": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "console_log_count": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "console_warn_count": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "console_error_count": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "start_url": {
      "type": "string",
      "readOnly": true,
      "nullable": true
    },
    "person": {
      "$ref": "#/components/schemas/MinimalPerson"
    },
    "retention_period_days": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "expiry_time": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "nullable": true
    },
    "recording_ttl": {
      "type": "integer",
      "readOnly": true,
      "nullable": true
    },
    "snapshot_source": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "snapshot_library": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "ongoing": {
      "type": "boolean",
      "readOnly": true
    },
    "activity_score": {
      "type": "number",
      "format": "double",
      "nullable": true,
      "readOnly": true
    },
    "has_summary": {
      "type": "boolean",
      "readOnly": true
    },
    "summary_outcome": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Outcome"
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "external_references": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      },
      "description": "Load external references (linked issues) for this recording",
      "readOnly": true
    }
  },
  "required": [
    "active_seconds",
    "activity_score",
    "click_count",
    "console_error_count",
    "console_log_count",
    "console_warn_count",
    "distinct_id",
    "end_time",
    "expiry_time",
    "external_references",
    "has_summary",
    "id",
    "inactive_seconds",
    "keypress_count",
    "mouse_activity_count",
    "ongoing",
    "recording_duration",
    "recording_ttl",
    "retention_period_days",
    "snapshot_library",
    "snapshot_source",
    "start_time",
    "start_url",
    "summary_outcome",
    "viewed",
    "viewers"
  ]
}