PostHog

PostHog replay API

The replay API from PostHog — 13 operation(s) for replay.

GitHub OpenAPI

Operations 29

GET /api/environments/{environment_id}/session_recording_playlists/ #
POST /api/environments/{environment_id}/session_recording_playlists/ #
GET /api/environments/{environment_id}/session_recording_playlists/{short_id}/ #
PUT /api/environments/{environment_id}/session_recording_playlists/{short_id}/ #
PATCH /api/environments/{environment_id}/session_recording_playlists/{short_id}/ #
DELETE /api/environments/{environment_id}/session_recording_playlists/{short_id}/ #
GET /api/environments/{environment_id}/session_recording_playlists/{short_id}/recordings/ #
POST /api/environments/{environment_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/ #
DELETE /api/environments/{environment_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/ #
GET /api/environments/{environment_id}/session_recordings/ #
GET /api/environments/{environment_id}/session_recordings/{id}/ #
PUT /api/environments/{environment_id}/session_recordings/{id}/ #
PATCH /api/environments/{environment_id}/session_recordings/{id}/ #
DELETE /api/environments/{environment_id}/session_recordings/{id}/ #
POST /api/environments/{project_id}/session_summaries/create_session_summaries_individually/ #
GET /api/projects/{project_id}/session_recording_playlists/ #
POST /api/projects/{project_id}/session_recording_playlists/ #
GET /api/projects/{project_id}/session_recording_playlists/{short_id}/ #
PUT /api/projects/{project_id}/session_recording_playlists/{short_id}/ #
PATCH /api/projects/{project_id}/session_recording_playlists/{short_id}/ #
DELETE /api/projects/{project_id}/session_recording_playlists/{short_id}/ #
GET /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/ #
POST /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/ #
DELETE /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/ #
GET /api/projects/{project_id}/session_recordings/ #
GET /api/projects/{project_id}/session_recordings/{id}/ #
PUT /api/projects/{project_id}/session_recordings/{id}/ #
PATCH /api/projects/{project_id}/session_recordings/{id}/ #
DELETE /api/projects/{project_id}/session_recordings/{id}/ #

Documentation

📖
Documentation
https://posthog.com/docs/api
📖
GettingStarted
https://posthog.com/docs/api
📖
Authentication
https://posthog.com/docs/api#authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/openapi/posthog-replay-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/asyncapi/posthog-webhooks-asyncapi.yml

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/graphql/posthog-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/posthog-replay-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

posthog-replay-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PostHog actions Replay API
  version: 1.0.0
  description: ''
servers:
- url: https://app.posthog.com/api
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: replay
paths:
  /api/environments/{environment_id}/session_recording_playlists/:
    get:
      operationId: environments_session_recording_playlists_list
      description: Override list to include synthetic playlists
      parameters:
      - in: query
        name: created_by
        schema:
          type: integer
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: short_id
        schema:
          type: string
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSessionRecordingPlaylistList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - replay
    post:
      operationId: environments_session_recording_playlists_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecordingPlaylist'
          description: ''
      deprecated: true
      x-explicit-tags:
      - replay
  /api/environments/{environment_id}/session_recording_playlists/{short_id}/:
    get:
      operationId: environments_session_recording_playlists_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecordingPlaylist'
          description: ''
      deprecated: true
      x-explicit-tags:
      - replay
    put:
      operationId: environments_session_recording_playlists_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecordingPlaylist'
          description: ''
      deprecated: true
      x-explicit-tags:
      - replay
    patch:
      operationId: environments_session_recording_playlists_partial_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecordingPlaylist'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecordingPlaylist'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecordingPlaylist'
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecordingPlaylist'
          description: ''
      deprecated: true
      x-explicit-tags:
      - replay
    delete:
      operationId: environments_session_recording_playlists_destroy
      description: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:write
      responses:
        '405':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - replay
  /api/environments/{environment_id}/session_recording_playlists/{short_id}/recordings/:
    get:
      operationId: environments_session_recording_playlists_recordings_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:read
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - replay
  /api/environments/{environment_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/:
    post:
      operationId: environments_session_recording_playlists_recordings_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: session_recording_id
        schema:
          type: string
        required: true
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - replay
    delete:
      operationId: environments_session_recording_playlists_recordings_destroy
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: session_recording_id
        schema:
          type: string
        required: true
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      responses:
        '204':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - replay
  /api/environments/{environment_id}/session_recordings/:
    get:
      operationId: environments_session_recordings_list
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSessionRecordingList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - replay
  /api/environments/{environment_id}/session_recordings/{id}/:
    get:
      operationId: environments_session_recordings_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this session recording.
        required: true
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecording'
          description: ''
      deprecated: true
      x-explicit-tags:
      - replay
    put:
      operationId: environments_session_recordings_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this session recording.
        required: true
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionRecording'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SessionRecording'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SessionRecording'
      security:
      - PersonalAPIKeyAuth:
        - session_recording:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecording'
          description: ''
      deprecated: true
      x-explicit-tags:
      - replay
    patch:
      operationId: environments_session_recordings_partial_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this session recording.
        required: true
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecording'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecording'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecording'
      security:
      - PersonalAPIKeyAuth:
        - session_recording:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecording'
          description: ''
      deprecated: true
      x-explicit-tags:
      - replay
    delete:
      operationId: environments_session_recordings_destroy
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this session recording.
        required: true
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording:write
      responses:
        '204':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - replay
  /api/environments/{project_id}/session_summaries/create_session_summaries_individually/:
    post:
      operationId: create_session_summaries_individually
      description: Generate AI individual summary for each session, without grouping.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionSummaries'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SessionSummaries'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SessionSummaries'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - session_recording:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionSummaries'
          description: ''
      x-explicit-tags:
      - replay
  /api/projects/{project_id}/session_recording_playlists/:
    get:
      operationId: session_recording_playlists_list
      description: Override list to include synthetic playlists
      parameters:
      - in: query
        name: created_by
        schema:
          type: integer
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: query
        name: short_id
        schema:
          type: string
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSessionRecordingPlaylistList'
          description: ''
      x-explicit-tags:
      - replay
    post:
      operationId: session_recording_playlists_create
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecordingPlaylist'
          description: ''
      x-explicit-tags:
      - replay
  /api/projects/{project_id}/session_recording_playlists/{short_id}/:
    get:
      operationId: session_recording_playlists_retrieve
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecordingPlaylist'
          description: ''
      x-explicit-tags:
      - replay
    put:
      operationId: session_recording_playlists_update
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecordingPlaylist'
          description: ''
      x-explicit-tags:
      - replay
    patch:
      operationId: session_recording_playlists_partial_update
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecordingPlaylist'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecordingPlaylist'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecordingPlaylist'
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecordingPlaylist'
          description: ''
      x-explicit-tags:
      - replay
    delete:
      operationId: session_recording_playlists_destroy
      description: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:write
      responses:
        '405':
          description: No response body
      x-explicit-tags:
      - replay
  /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/:
    get:
      operationId: session_recording_playlists_recordings_retrieve
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording_playlist:read
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - replay
  /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/:
    post:
      operationId: session_recording_playlists_recordings_create
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: path
        name: session_recording_id
        schema:
          type: string
        required: true
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SessionRecordingPlaylist'
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - replay
    delete:
      operationId: session_recording_playlists_recordings_destroy
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: path
        name: session_recording_id
        schema:
          type: string
        required: true
      - in: path
        name: short_id
        schema:
          type: string
        required: true
      tags:
      - replay
      responses:
        '204':
          description: No response body
      x-explicit-tags:
      - replay
  /api/projects/{project_id}/session_recordings/:
    get:
      operationId: session_recordings_list
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSessionRecordingList'
          description: ''
      x-explicit-tags:
      - replay
  /api/projects/{project_id}/session_recordings/{id}/:
    get:
      operationId: session_recordings_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this session recording.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecording'
          description: ''
      x-explicit-tags:
      - replay
    put:
      operationId: session_recordings_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this session recording.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionRecording'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SessionRecording'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SessionRecording'
      security:
      - PersonalAPIKeyAuth:
        - session_recording:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecording'
          description: ''
      x-explicit-tags:
      - replay
    patch:
      operationId: session_recordings_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this session recording.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - replay
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecording'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecording'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSessionRecording'
      security:
      - PersonalAPIKeyAuth:
        - session_recording:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRecording'
          description: ''
      x-explicit-tags:
      - replay
    delete:
      operationId: session_recordings_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this session recording.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - replay
      security:
      - PersonalAPIKeyAuth:
        - session_recording:write
      responses:
        '204':
          description: No response body
      x-explicit-tags:
      - replay
components:
  schemas:
    UserBasic:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        uuid:
          type: string
          format: uuid
          readOnly: true
        distinct_id:
          type:
          - string
          - 'null'
          maxLength: 200
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
        email:
          type: string
          format: email
          title: Email address
          maxLength: 254
        is_email_verified:
          type:
          - boolean
          - 'null'
        hedgehog_config:
          type:
          - object
          - 'null'
          additionalProperties: true
          readOnly: true
        role_at_organization:
          oneOf:
          - $ref: '#/components/schemas/RoleAtOrganizationEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
      required:
      - email
      - hedgehog_config
      - id
      - uuid
    SessionRecording:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        distinct_id:
          type:
          - string
          - 'null'
          readOnly: true
        viewed:
          type: boolean
          readOnly: true
        viewers:
          type: array
          items:
            type: string
          readOnly: true
        recording_duration:
          type: integer
          readOnly: true
        active_seconds:
          type:
          - integer
          - 'null'
          readOnly: true
        inactive_seconds:
          type:
          - integer
          - 'null'
          readOnly: true
        start_time:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        end_time:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        click_count:
          type:
          - integer
          - 'null'
          readOnly: true
        keypress_count:
          type:
          - integer
          - 'null'
          readOnly: true
        mouse_activity_count:
          type:
          - integer
          - 'null'
          readOnly: true
        console_log_count:
          type:
          - integer
          - 'null'
          readOnly: true
        console_warn_count:
          type:
          - integer
          - 'null'
          readOnly: true
        console_error_count:
          type:
          - integer
          - 'null'
          readOnly: true
        start_url:
          type:
          - string
          - 'null'
          readOnly: true
        person:
          $ref: '#/components/schemas/MinimalPerson'
        retention_period_days:
          type:
          - integer
          - 'null'
          readOnly: true
        expiry_time:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        recording_ttl:
          type:
          - integer
          - 'null'
          readOnly: true
        snapshot_source:
          type:
          - string
          - 'null'
          readOnly: true
        snapshot_library:
          type:
          - string
          - 'null'
          readOnly: true
        ongoing:
          type: boolean
          readOnly: true
        activity_score:
          type:
          - number
          - 'null'
          format: double
          readOnly: true
        has_summary:
          type: boolean
          readOnly: true
        summary_outcome:
          allOf:
          - $ref: '#/components/schemas/Outcome'
          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
    SessionRecordingPlaylist:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        short_id:
          type: string
          readOnly: true
        name:
          type:
          - string
          - 'null'
          description: Human-readable name for the playlist.
          maxLength: 400
        derived_name:
          type:
          - string
          - 'null'
          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 — 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
          readOnly: true
        type:
          description: 'Playlist type: ''collection'' for manually curated recordings, ''filters'' for saved filter views. Required on create, cannot be changed after.


            * `collection` - Collection

            * `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'
      required:
      - created_at
      - created_by
      - id
      - is_synthetic
      - last_modified_at
      - last_modified_by
      - recordings_counts
      - short_id
    BlankEnum:
      enum:
      - ''
    PatchedSessionRecordingPlaylist:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        short_id:
          type: string
          readOnly: true
        name:
          type:
          - string
          - 'null'
          description: Human-readable name for the playlist.
          maxLength: 400
        derived_name:
          type:
          - string
          - 'null'
          maxLength: 400
        description:
          type: string
          description: Optional description of the playlist's purpose or contents.
 

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/openapi/posthog-replay-api-openapi.yml