Replay-2

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

DELETE
GET
POST
DELETE
GET
GET
PATCH
DELETE
POST
← Previous page

Delete session recording playlists

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

session_recording_playlist:write

Path parameters

  • short_id
    string

Example request

DELETE /api/projects/:project_id/session_recording_playlists/:short_id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/session_recording_playlists/:short_id/

Example response

Status 405 No response body

Retrieve session recording playlists recordings

Required API key scopes

session_recording_playlist:read

Path parameters

  • short_id
    string

Example request

GET /api/projects/:project_id/session_recording_playlists/:short_id/recordings
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/session_recording_playlists/:short_id/recordings/

Example response

Status 200 No response body

Create session recording playlists recordings

Path parameters

  • session_recording_id
    string
  • short_id
    string

Request parameters

  • name
    stringnull
  • derived_name
    stringnull
  • description
    string
  • pinned
    boolean
  • deleted
    boolean
  • filters
  • type
  • _create_in_folder
    string

Example request

POST /api/projects/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id/\
	-d name=["string","null"]

Example response

Status 200 No response body

Delete session recording playlists recordings

Path parameters

  • session_recording_id
    string
  • short_id
    string

Example request

DELETE /api/projects/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id/

Example response

Status 204 No response body

List all session recordings

Required API key scopes

session_recording:read

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/projects/:project_id/session_recordings
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/session_recordings/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "string",
      "distinct_id": "string",
      "viewed": true,
      "viewers": [
        "string"
      ],
      "recording_duration": 0,
      "active_seconds": 0,
      "inactive_seconds": 0,
      "start_time": "2019-08-24T14:15:22Z",
      "end_time": "2019-08-24T14:15:22Z",
      "click_count": 0,
      "keypress_count": 0,
      "mouse_activity_count": 0,
      "console_log_count": 0,
      "console_warn_count": 0,
      "console_error_count": 0,
      "start_url": "string",
      "person": {
        "id": 0,
        "name": "string",
        "distinct_ids": [
          "string"
        ],
        "properties": null,
        "created_at": "2019-08-24T14:15:22Z",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "last_seen_at": "2019-08-24T14:15:22Z"
      },
      "retention_period_days": 0,
      "expiry_time": "2019-08-24T14:15:22Z",
      "recording_ttl": 0,
      "snapshot_source": "string",
      "snapshot_library": "string",
      "ongoing": true,
      "activity_score": 0,
      "has_summary": true,
      "summary_outcome": {
        "description": "string",
        "success": true
      },
      "external_references": [
        {}
      ],
      "matches_filters": true
    }
  ]
}

Retrieve session recordings

Required API key scopes

session_recording:read

Path parameters

  • id
    string

Response


Example request

GET /api/projects/:project_id/session_recordings/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/session_recordings/:id/

Example response

Status 200
RESPONSE
{
  "id": "string",
  "distinct_id": "string",
  "viewed": true,
  "viewers": [
    "string"
  ],
  "recording_duration": 0,
  "active_seconds": 0,
  "inactive_seconds": 0,
  "start_time": "2019-08-24T14:15:22Z",
  "end_time": "2019-08-24T14:15:22Z",
  "click_count": 0,
  "keypress_count": 0,
  "mouse_activity_count": 0,
  "console_log_count": 0,
  "console_warn_count": 0,
  "console_error_count": 0,
  "start_url": "string",
  "person": {
    "id": 0,
    "name": "string",
    "distinct_ids": [
      "string"
    ],
    "properties": null,
    "created_at": "2019-08-24T14:15:22Z",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "last_seen_at": "2019-08-24T14:15:22Z"
  },
  "retention_period_days": 0,
  "expiry_time": "2019-08-24T14:15:22Z",
  "recording_ttl": 0,
  "snapshot_source": "string",
  "snapshot_library": "string",
  "ongoing": true,
  "activity_score": 0,
  "has_summary": true,
  "summary_outcome": {
    "description": "string",
    "success": true
  },
  "external_references": [
    {}
  ],
  "matches_filters": true
}

Update session recordings

Required API key scopes

session_recording:write

Path parameters

  • id
    string

Request parameters

  • person

Response


Example request

PATCH /api/projects/:project_id/session_recordings/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/session_recordings/:id/\
	-d distinct_id=["string","null"]

Example response

Status 200
RESPONSE
{
  "id": "string",
  "distinct_id": "string",
  "viewed": true,
  "viewers": [
    "string"
  ],
  "recording_duration": 0,
  "active_seconds": 0,
  "inactive_seconds": 0,
  "start_time": "2019-08-24T14:15:22Z",
  "end_time": "2019-08-24T14:15:22Z",
  "click_count": 0,
  "keypress_count": 0,
  "mouse_activity_count": 0,
  "console_log_count": 0,
  "console_warn_count": 0,
  "console_error_count": 0,
  "start_url": "string",
  "person": {
    "id": 0,
    "name": "string",
    "distinct_ids": [
      "string"
    ],
    "properties": null,
    "created_at": "2019-08-24T14:15:22Z",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "last_seen_at": "2019-08-24T14:15:22Z"
  },
  "retention_period_days": 0,
  "expiry_time": "2019-08-24T14:15:22Z",
  "recording_ttl": 0,
  "snapshot_source": "string",
  "snapshot_library": "string",
  "ongoing": true,
  "activity_score": 0,
  "has_summary": true,
  "summary_outcome": {
    "description": "string",
    "success": true
  },
  "external_references": [
    {}
  ],
  "matches_filters": true
}

Delete session recordings

Required API key scopes

session_recording:write

Path parameters

  • id
    string

Example request

DELETE /api/projects/:project_id/session_recordings/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/session_recordings/:id/

Example response

Status 204 No response body

Create create session summaries

Generate AI individual summary for each session, without grouping.

Required API key scopes

session_recording:read

Request parameters

  • session_ids
    array
  • focus_area
    string

Response


Example request

POST /api/projects/:project_id/session_summaries/create_session_summaries_individually
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/session_summaries/create_session_summaries_individually/\
	-d session_ids="array"

Example response

Status 200
RESPONSE
{
  "session_ids": [
    "string"
  ],
  "focus_area": "string"
}
← Previous page

Community questions

Questions about this page? or post a community question.