Session recordings

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

Endpoints

GET
GET
PATCH
DELETE
GET
POST
DELETE
POST

List all session recordings list

Required API key scopes

session_recording:read

Path parameters

  • project_id
    string

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"
      },
      "retention_period_days": 0,
      "expiry_time": "string",
      "recording_ttl": "string",
      "snapshot_source": "string",
      "snapshot_library": "string",
      "ongoing": true,
      "activity_score": 0.1,
      "external_references": [
        {
          "property1": null,
          "property2": null
        }
      ]
    }
  ]
}

Retrieve session recordings retrieve

Required API key scopes

session_recording:read

Path parameters

  • id
    string
  • project_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"
  },
  "retention_period_days": 0,
  "expiry_time": "string",
  "recording_ttl": "string",
  "snapshot_source": "string",
  "snapshot_library": "string",
  "ongoing": true,
  "activity_score": 0.1,
  "external_references": [
    {
      "property1": null,
      "property2": null
    }
  ]
}

Update session recordings update

Required API key scopes

session_recording:write

Path parameters

  • id
    string
  • project_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"

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"
  },
  "retention_period_days": 0,
  "expiry_time": "string",
  "recording_ttl": "string",
  "snapshot_source": "string",
  "snapshot_library": "string",
  "ongoing": true,
  "activity_score": 0.1,
  "external_references": [
    {
      "property1": null,
      "property2": null
    }
  ]
}

Delete session recordings destroy

Required API key scopes

session_recording:write

Path parameters

  • id
    string
  • project_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

List all session recordings sharing list

Required API key scopes

sharing_configuration:read

Path parameters

  • project_id
    string
  • recording_id
    string

Example request

GET /api/projects/:project_id/session_recordings/:recording_id/sharing
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/:recording_id/sharing/

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Create session recordings sharing passwords create

Create a new password for the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • project_id
    string
  • recording_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/projects/:project_id/session_recordings/:recording_id/sharing/passwords
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_recordings/:recording_id/sharing/passwords/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Delete session recordings sharing passwords destroy

Delete a password from the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • password_id
    string
  • project_id
    string
  • recording_id
    string

Example request

DELETE /api/projects/:project_id/session_recordings/:recording_id/sharing/passwords/:password_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/:recording_id/sharing/passwords/:password_id/

Example response

Status 204 No response body

Create session recordings sharing refresh create

Required API key scopes

sharing_configuration:write

Path parameters

  • project_id
    string
  • recording_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/projects/:project_id/session_recordings/:recording_id/sharing/refresh
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_recordings/:recording_id/sharing/refresh/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Community questions

Questions about this page? or post a community question.