This endpoint does not provide the raw JSON of the replays. To get the raw JSON, you need to click Export as JSON in the replay options menu in-app. If you want us to build exports or have a strong opinion on how you'd like to use them, vote or comment on this issue on our roadmap.
Session recordings
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all session recordings
Required API key scopes
session_recording:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
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/
Response
Status 200
{"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"},"storage": "string","snapshot_source": "string","ongoing": true,"activity_score": 0.1}]}
Retrieve session recordings
Required API key scopes
session_recording:read
Path parameters
- idstring
A UUID string identifying this session recording.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
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/
Response
Status 200
{"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"},"storage": "string","snapshot_source": "string","ongoing": true,"activity_score": 0.1}
Update session recordings
Required API key scopes
session_recording:write
Path parameters
- idstring
A UUID string identifying this session recording.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- person
Response
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"
Response
Status 200
{"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"},"storage": "string","snapshot_source": "string","ongoing": true,"activity_score": 0.1}
Delete session recordings
Required API key scopes
session_recording:write
Path parameters
- idstring
A UUID string identifying this session recording.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
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/
Response
Status 204 No response body
List all session recordings sharing
Required API key scopes
sharing_configuration:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
- recording_idstring
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/
Response
Status 200
{"created_at": "2019-08-24T14:15:22Z","enabled": true,"access_token": "string"}