Environments-21

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

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/

Response

Status 204 No response body

List all environments session recordings sharing

Required API key scopes

sharing_configuration: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/.

  • recording_id
    string

Request

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

Response

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

List all environments session recordings sharing

Required API key scopes

sharing_configuration: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/.

  • recording_id
    string

Request

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

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 environments session recordings sharing passwords

Create a new password for the sharing configuration.

Required API key scopes

sharing_configuration: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/.

  • recording_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Request

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

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 environments session recordings sharing passwords

Create a new password for the sharing configuration.

Required API key scopes

sharing_configuration: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/.

  • recording_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Request

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

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 environments session recordings sharing passwords

Delete a password from the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • password_id
    string
  • 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/.

  • recording_id
    string

Request

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

Response

Status 204 No response body

Delete environments session recordings sharing passwords

Delete a password from the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • password_id
    string
  • 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/.

  • recording_id
    string

Request

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

Response

Status 204 No response body

Create environments session recordings sharing refresh

Required API key scopes

sharing_configuration: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/.

  • recording_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Request

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

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 environments session recordings sharing refresh

Required API key scopes

sharing_configuration: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/.

  • recording_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Request

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

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 create session

Generate AI summaries per-session and a general summary for a group of session 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/.

Request parameters

  • session_ids
    array

    List of session IDs to summarize (max 300)

  • focus_area
    string

    Optional focus area for the summarization

Response


Request

POST /api/environments/:project_id/session_summaries/create_session_summaries
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_summaries/create_session_summaries/\
	-d session_ids="array"

Response

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

Create create session

Generate AI summaries per-session and a general summary for a group of session 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/.

Request parameters

  • session_ids
    array

    List of session IDs to summarize (max 300)

  • focus_area
    string

    Optional focus area for the summarization

Response


Request

POST /api/environments/:project_id/session_summaries/create_session_summaries
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_summaries/create_session_summaries/\
	-d session_ids="array"

Response

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

Retrieve environments sessions property definitions

Required API key scopes

query: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/.

Request

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

Response

Status 200 No response body

Retrieve environments sessions property definitions

Required API key scopes

query: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/.

Request

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

Response

Status 200 No response body
Next page →

Community questions

Was this page useful?