Environments-13 API Reference

Environments-13

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

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

Endpoints

`DELETE`	`/api/environments/:project_id/session_recording_playlists/:short_id/`
`GET`	`/api/environments/:project_id/session_recording_playlists/:short_id/recordings/`
`POST`	`/api/environments/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id/`
`DELETE`	`/api/environments/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id/`
`GET`	`/api/environments/:project_id/session_recordings/`
`GET`	`/api/environments/:project_id/session_recordings/:id/`
`PATCH`	`/api/environments/:project_id/session_recordings/:id/`
`DELETE`	`/api/environments/:project_id/session_recordings/:id/`
`GET`	`/api/environments/:project_id/session_recordings/:recording_id/sharing/`

Delete environments session recording playlists

Required API key scopes

session_recording_playlist:write

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
short_id
string

Request

DELETE /api/environments/: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/environments/:project_id/session_recording_playlists/:short_id/

Response

Status 405 No response body

Delete environments session recording playlists

Required API key scopes

session_recording_playlist:write

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
short_id
string

Request

DELETE /api/environments/: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/environments/:project_id/session_recording_playlists/:short_id/

Response

Status 405 No response body

Retrieve environments session recording playlists recordings

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
short_id
string

Request

GET /api/environments/: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/environments/:project_id/session_recording_playlists/:short_id/recordings/

Response

Status 200 No response body

Retrieve environments session recording playlists recordings

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
short_id
string

Request

GET /api/environments/: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/environments/:project_id/session_recording_playlists/:short_id/recordings/

Response

Status 200 No response body

Create environments session recording playlists recordings

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
session_recording_id
string
short_id
string

Request parameters

name
string
derived_name
string
description
string
pinned
boolean
deleted
boolean
filters

Request

POST /api/environments/: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/environments/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id/\
	-d name="string"

Response

Status 200 No response body

Create environments session recording playlists recordings

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
session_recording_id
string
short_id
string

Request parameters

name
string
derived_name
string
description
string
pinned
boolean
deleted
boolean
filters

Request

POST /api/environments/: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/environments/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id/\
	-d name="string"

Response

Status 200 No response body

Delete environments session recording playlists recordings

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
session_recording_id
string
short_id
string

Request

DELETE /api/environments/: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/environments/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id/

Response

Status 204 No response body

Delete environments session recording playlists recordings

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
session_recording_id
string
short_id
string

Request

DELETE /api/environments/: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/environments/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id/

Response

Status 204 No response body

List all environments session recordings

Required API key scopes

session_recording:read

Path parameters

project_id
string
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

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/environments/: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/environments/:project_id/session_recordings/

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"
      },
      "storage": "string",
      "snapshot_source": "string",
      "ongoing": true,
      "activity_score": 0.1
    }
  ]
}

List all environments session recordings

Required API key scopes

session_recording:read

Path parameters

project_id
string
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

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/environments/: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/environments/:project_id/session_recordings/

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"
      },
      "storage": "string",
      "snapshot_source": "string",
      "ongoing": true,
      "activity_score": 0.1
    }
  ]
}

Retrieve environments session recordings

Required API key scopes

session_recording:read

Path parameters

id
string
A UUID string identifying this session recording.
project_id
string
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/environments/: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/environments/:project_id/session_recordings/:id/

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"
  },
  "storage": "string",
  "snapshot_source": "string",
  "ongoing": true,
  "activity_score": 0.1
}

Retrieve environments session recordings

Required API key scopes

session_recording:read

Path parameters

id
string
A UUID string identifying this session recording.
project_id
string
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/environments/: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/environments/:project_id/session_recordings/:id/

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"
  },
  "storage": "string",
  "snapshot_source": "string",
  "ongoing": true,
  "activity_score": 0.1
}

Update environments session recordings

Required API key scopes

session_recording:write

Path parameters

id
string
A UUID string identifying this session recording.
project_id
string
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/environments/: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/environments/:project_id/session_recordings/:id/\
	-d distinct_id="string"

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"
  },
  "storage": "string",
  "snapshot_source": "string",
  "ongoing": true,
  "activity_score": 0.1
}

Update environments session recordings

Required API key scopes

session_recording:write

Path parameters

id
string
A UUID string identifying this session recording.
project_id
string
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/environments/: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/environments/:project_id/session_recordings/:id/\
	-d distinct_id="string"

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"
  },
  "storage": "string",
  "snapshot_source": "string",
  "ongoing": true,
  "activity_score": 0.1
}

Delete environments session recordings

Required API key scopes

session_recording:write

Path parameters

id
string
A UUID string identifying this session recording.
project_id
string
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/environments/: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/environments/:project_id/session_recordings/:id/

Response

Status 204 No response body

Delete environments session recordings

Required API key scopes

session_recording:write

Path parameters

id
string
A UUID string identifying this session recording.
project_id
string
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/environments/: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/environments/:project_id/session_recordings/:id/