Session API Reference

Session

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

Endpoints

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

Retrieve environments retrieve session summaries

Retrieve the team's session summaries configuration (product context used to tailor single-session replay summaries).

Response

Example request

GET /api/environments/:environment_id/session_summaries/config
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/session_summaries/config/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/session_summaries/config/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "product_context": "string",
  "custom_tags": {
    "property1": "string",
    "property2": "string"
  }
}

Update environments update session summaries

Update the team's session summaries configuration (product context used to tailor single-session replay summaries).

Request parameters

product_context
string
custom_tags
object

Response

Example request

PATCH /api/environments/:environment_id/session_summaries/config
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/session_summaries/config/\
	-d product_context="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/session_summaries/config/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"product_context": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "product_context": "string",
  "custom_tags": {
    "property1": "string",
    "property2": "string"
  }
}

Create environments create session

Generate AI summary for a group of session recordings to find patterns and generate a notebook.

Required API key scopes

session_recording:read

Request parameters

session_ids
array
focus_area
string

Response

Example request

POST /api/environments/:environment_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/:environment_id/session_summaries/create_session_summaries/\
	-d session_ids="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/session_summaries/create_session_summaries/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"session_ids": "array"
	}
).json()

Example response

Status 200

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

Create environments create session summaries

Generate AI individual summary for each session, without grouping.

Required API key scopes

session_recording:read

Request parameters

session_ids
array
focus_area
string

Response

Example request

POST /api/environments/:environment_id/session_summaries/create_session_summaries_individually
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/:environment_id/session_summaries/create_session_summaries_individually/\
	-d session_ids="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/session_summaries/create_session_summaries_individually/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"session_ids": "array"
	}
).json()

Example response

Status 200

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

Retrieve retrieve session summaries

Retrieve the team's session summaries configuration (product context used to tailor single-session replay summaries).

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "product_context": "string",
  "custom_tags": {
    "property1": "string",
    "property2": "string"
  }
}

Update update session summaries

Update the team's session summaries configuration (product context used to tailor single-session replay summaries).

Request parameters

product_context
string
custom_tags
object

Response

Example request

PATCH /api/projects/:project_id/session_summaries/config
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_summaries/config/\
	-d product_context="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/session_summaries/config/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"product_context": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "product_context": "string",
  "custom_tags": {
    "property1": "string",
    "property2": "string"
  }
}

Create create session

Generate AI summary for a group of session recordings to find patterns and generate a notebook.

Required API key scopes

session_recording:read

Request parameters

session_ids
array
focus_area
string

Response

Example request

POST /api/projects/: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/projects/:project_id/session_summaries/create_session_summaries/\
	-d session_ids="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/session_summaries/create_session_summaries/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"session_ids": "array"
	}
).json()

Example response

Status 200

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

Create create session summaries

Generate AI individual summary for each session, without grouping.

Required API key scopes

session_recording:read

Request parameters

session_ids
array
focus_area
string

Response

Example request

POST /api/projects/:project_id/session_summaries/create_session_summaries_individually
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_summaries/create_session_summaries_individually/\
	-d session_ids="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/session_summaries/create_session_summaries_individually/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"session_ids": "array"
	}
).json()

Example response

Status 200

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

Session

Endpoints

Retrieve environments retrieve session summaries

Response

Example request

Example response

Status 200

Update environments update session summaries

Request parameters

Response

Example request

Example response

Status 200

Create environments create session

Required API key scopes

Request parameters

Response

Example request

Example response

Status 200

Create environments create session summaries

Required API key scopes

Request parameters

Response

Example request

Example response

Status 200

Retrieve retrieve session summaries

Response

Example request

Example response

Status 200

Update update session summaries

Request parameters

Response

Example request

Example response

Status 200

Create create session

Required API key scopes

Request parameters

Response

Example request

Example response

Status 200

Create create session summaries

Required API key scopes

Request parameters

Response

Example request

Example response

Status 200

Community questions