Replay-2 API Reference

Replay-2

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

Endpoints

`GET`
`POST`
`DELETE`
`GET`
`GET`
`PATCH`
`DELETE`

Retrieve session recording playlists recordings

Required API key scopes

session_recording_playlist:read

Path parameters

project_id
string
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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/".format(
        project_id=project_id,
		short_id="<the short id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create session recording playlists recordings

Path parameters

project_id
string
session_recording_id
string
short_id
string

Request parameters

name
string
derived_name
string
description
string
pinned
boolean
deleted
boolean
filters
_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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/".format(
        project_id=project_id,
		session_recording_id="<the session recording id>",,
		short_id="<the short id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200 No response body

Delete session recording playlists recordings

Path parameters

project_id
string
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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/".format(
        project_id=project_id,
		session_recording_id="<the session recording id>",,
		short_id="<the short id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

List all session recordings

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/session_recordings/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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": "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

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/session_recordings/{replay-2_id}/".format(
        project_id=project_id,
		replay-2_id="<the replay-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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": "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

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/session_recordings/{replay-2_id}/".format(
        project_id=project_id,
		replay-2_id="<the replay-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"distinct_id": "string"
	}
).json()

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": "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

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/session_recordings/{replay-2_id}/".format(
        project_id=project_id,
		replay-2_id="<the replay-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Replay-2

Endpoints

Retrieve session recording playlists recordings

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Create session recording playlists recordings

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Delete session recording playlists recordings

Path parameters

Example request

Example response

Status 204 No response body

List all session recordings

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Retrieve session recordings

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update session recordings

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete session recordings

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Community questions