Environments-23 API Reference

Delete environments session recordings

Required API key scopes

session_recording:write

Path parameters

id
string
project_id
string

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

Example response

Status 204 No response body

Create create session

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

Path parameters

project_id
string

Request parameters

session_ids
array
focus_area
string

Response

Example 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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{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

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

Path parameters

project_id
string

Request parameters

session_ids
array
focus_area
string

Response

Example 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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{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.

Path parameters

project_id
string

Request parameters

session_ids
array
focus_area
string

Response

Example request

POST /api/environments/: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/environments/: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/environments/{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"
}

Create create session summaries

Generate AI individual summary for each session, without grouping.

Path parameters

project_id
string

Request parameters

session_ids
array
focus_area
string

Response

Example request

POST /api/environments/: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/environments/: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/environments/{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"
}

Retrieve environments sessions property definitions

Required API key scopes

query:read

Path parameters

project_id
string

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

Example response

Status 200 No response body

Retrieve environments sessions property definitions

Required API key scopes

query:read

Path parameters

project_id
string

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

Example response

Status 200 No response body

Retrieve environments sessions values

Required API key scopes

query:read

Path parameters

project_id
string

Example request

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

Example response

Status 200 No response body

Retrieve environments sessions values

Required API key scopes

query:read

Path parameters

project_id
string

Example request

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

Example response

Status 200 No response body

List all environments subscriptions

Required API key scopes

subscription:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:project_id/subscriptions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/subscriptions/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/subscriptions/".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": 0,
      "dashboard": 0,
      "insight": 0,
      "target_type": "email",
      "target_value": "string",
      "frequency": "daily",
      "interval": -2147483648,
      "byweekday": [
        "monday"
      ],
      "bysetpos": -2147483648,
      "count": -2147483648,
      "start_date": "2019-08-24T14:15:22Z",
      "until_date": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "deleted": true,
      "title": "string",
      "summary": "string",
      "next_delivery_date": "2019-08-24T14:15:22Z",
      "invite_message": "string"
    }
  ]
}

Create environments subscriptions

Required API key scopes

subscription:write

Path parameters

project_id
string

Request parameters

dashboard
integer
insight
integer
target_type
target_value
string
frequency
interval
integer
byweekday
array
bysetpos
integer
count
integer
start_date
string
until_date
string
deleted
boolean
title
string
invite_message
string

Response

Example request

POST /api/environments/:project_id/subscriptions
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/subscriptions/\
	-d target_type=undefined,\
	-d target_value="string",\
	-d frequency=undefined,\
	-d start_date="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/subscriptions/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"target_value": "string",
		"start_date": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": 0,
  "dashboard": 0,
  "insight": 0,
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": -2147483648,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "deleted": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "invite_message": "string"
}

Retrieve environments subscriptions

Required API key scopes

subscription:read

Path parameters

id
integer
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": 0,
  "dashboard": 0,
  "insight": 0,
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": -2147483648,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "deleted": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "invite_message": "string"
}

Update environments subscriptions

Required API key scopes

subscription:write

Path parameters

id
integer
project_id
string

Request parameters

dashboard
integer
insight
integer
target_type
target_value
string
frequency
interval
integer
byweekday
array
bysetpos
integer
count
integer
start_date
string
until_date
string
deleted
boolean
title
string
invite_message
string

Response

Example request

PATCH /api/environments/:project_id/subscriptions/: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/subscriptions/:id/\
	-d dashboard="integer"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/subscriptions/{environments-23_id}/".format(
        project_id=project_id,
		environments-23_id="<the environments-23 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"dashboard": "integer"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "dashboard": 0,
  "insight": 0,
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": -2147483648,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "deleted": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "invite_message": "string"
}

Delete environments subscriptions

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

Required API key scopes

subscription:write

Path parameters

id
integer
project_id
string

Example request

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

Example response

Status 405 No response body

List all environments user interviews

Required API key scopes

user_interview_DO_NOT_USE:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:project_id/user_interviews
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/user_interviews/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/user_interviews/".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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "interviewee_emails": [
        "string"
      ],
      "transcript": "string",
      "summary": "string",
      "audio": "http://example.com"
    }
  ]
}

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

Environments-23

Endpoints

Delete environments session recordings

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

List all environments session recordings sharing

Required API key scopes

Path parameters

Example request

Example response

Status 200

Create environments session recordings sharing passwords

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete environments session recordings sharing passwords

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Create environments session recordings sharing refresh

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Create create session

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Create create session

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Create create session summaries

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Create create session summaries

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Retrieve environments sessions property definitions

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve environments sessions property definitions

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve environments sessions values

Required API key scopes

Path parameters

Example request