Environments-24 API Reference

Environments-24

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

Endpoints

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

Create environments query check auth for async

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

Example request

POST /api/environments/:project_id/query/check_auth_for_async

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/query/check_auth_for_async/

Example response

Status 200 No response body

Retrieve environments query draft sql

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

Example request

GET /api/environments/:project_id/query/draft_sql

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

Example response

Status 200 No response body

Retrieve environments query draft sql

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

Example request

GET /api/environments/:project_id/query/draft_sql

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

Example response

Status 200 No response body

Create environments query upgrade

Upgrades a query without executing it. Returns a query with all nodes migrated to the latest version.

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

query

Response

Example request

POST /api/environments/:project_id/query/upgrade

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/query/upgrade/\
	-d query=undefined

Example response

Status 200

RESPONSE

{
  "query": {
    "custom_name": null,
    "event": null,
    "fixedProperties": null,
    "kind": "EventsNode",
    "limit": null,
    "math": null,
    "math_group_type_index": null,
    "math_hogql": null,
    "math_multiplier": null,
    "math_property": null,
    "math_property_revenue_currency": null,
    "math_property_type": null,
    "name": null,
    "optionalInFunnel": null,
    "orderBy": null,
    "properties": null,
    "response": null,
    "version": null
  }
}

Create environments query upgrade

Upgrades a query without executing it. Returns a query with all nodes migrated to the latest version.

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

query

Response

Example request

POST /api/environments/:project_id/query/upgrade

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/query/upgrade/\
	-d query=undefined

Example response

Status 200

RESPONSE

{
  "query": {
    "custom_name": null,
    "event": null,
    "fixedProperties": null,
    "kind": "EventsNode",
    "limit": null,
    "math": null,
    "math_group_type_index": null,
    "math_hogql": null,
    "math_multiplier": null,
    "math_property": null,
    "math_property_revenue_currency": null,
    "math_property_type": null,
    "name": null,
    "optionalInFunnel": null,
    "orderBy": null,
    "properties": null,
    "response": null,
    "version": null
  }
}

List all environments session recording playlists

Required API key scopes

session_recording_playlist: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

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

Response

Example request

GET /api/environments/:project_id/session_recording_playlists

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/

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,
      "short_id": "string",
      "name": "string",
      "derived_name": "string",
      "description": "string",
      "pinned": true,
      "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,
      "filters": null,
      "last_modified_at": "2019-08-24T14:15:22Z",
      "last_modified_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"
      },
      "recordings_counts": {
        "property1": {
          "property1": 0,
          "property2": 0
        },
        "property2": {
          "property1": 0,
          "property2": 0
        }
      },
      "type": "collection",
      "_create_in_folder": "string"
    }
  ]
}

List all environments session recording playlists

Required API key scopes

session_recording_playlist: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

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

Response

Example request

GET /api/environments/:project_id/session_recording_playlists

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/

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,
      "short_id": "string",
      "name": "string",
      "derived_name": "string",
      "description": "string",
      "pinned": true,
      "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,
      "filters": null,
      "last_modified_at": "2019-08-24T14:15:22Z",
      "last_modified_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"
      },
      "recordings_counts": {
        "property1": {
          "property1": 0,
          "property2": 0
        },
        "property2": {
          "property1": 0,
          "property2": 0
        }
      },
      "type": "collection",
      "_create_in_folder": "string"
    }
  ]
}

Create 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/.

Request parameters

name
string
derived_name
string
description
string
pinned
boolean
deleted
boolean
filters
_create_in_folder
string

Response

Example request

POST /api/environments/:project_id/session_recording_playlists

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/\
	-d name="string"

Example response

Status 201

RESPONSE

{
  "id": 0,
  "short_id": "string",
  "name": "string",
  "derived_name": "string",
  "description": "string",
  "pinned": true,
  "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,
  "filters": null,
  "last_modified_at": "2019-08-24T14:15:22Z",
  "last_modified_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"
  },
  "recordings_counts": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  },
  "type": "collection",
  "_create_in_folder": "string"
}

Create 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/.

Request parameters

name
string
derived_name
string
description
string
pinned
boolean
deleted
boolean
filters
_create_in_folder
string

Response

Example request

POST /api/environments/:project_id/session_recording_playlists

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/\
	-d name="string"

Example response

Status 201

RESPONSE

{
  "id": 0,
  "short_id": "string",
  "name": "string",
  "derived_name": "string",
  "description": "string",
  "pinned": true,
  "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,
  "filters": null,
  "last_modified_at": "2019-08-24T14:15:22Z",
  "last_modified_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"
  },
  "recordings_counts": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  },
  "type": "collection",
  "_create_in_folder": "string"
}

Retrieve environments session recording playlists

Required API key scopes

session_recording_playlist: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/.
short_id
string

Response

Example request

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

Example response

Status 200

RESPONSE

{
  "id": 0,
  "short_id": "string",
  "name": "string",
  "derived_name": "string",
  "description": "string",
  "pinned": true,
  "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,
  "filters": null,
  "last_modified_at": "2019-08-24T14:15:22Z",
  "last_modified_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"
  },
  "recordings_counts": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  },
  "type": "collection",
  "_create_in_folder": "string"
}

Retrieve environments session recording playlists

Required API key scopes

session_recording_playlist: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/.
short_id
string

Response

Example request

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

Example response

Status 200

RESPONSE

{
  "id": 0,
  "short_id": "string",
  "name": "string",
  "derived_name": "string",
  "description": "string",
  "pinned": true,
  "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,
  "filters": null,
  "last_modified_at": "2019-08-24T14:15:22Z",
  "last_modified_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"
  },
  "recordings_counts": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  },
  "type": "collection",
  "_create_in_folder": "string"
}

Update 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 parameters

name
string
derived_name
string
description
string
pinned
boolean
deleted
boolean
filters
_create_in_folder
string

Response

Example request

PATCH /api/environments/:project_id/session_recording_playlists/:short_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_recording_playlists/:short_id/\
	-d name="string"

Example response

Status 200

RESPONSE

{
  "id": 0,
  "short_id": "string",
  "name": "string",
  "derived_name": "string",
  "description": "string",
  "pinned": true,
  "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,
  "filters": null,
  "last_modified_at": "2019-08-24T14:15:22Z",
  "last_modified_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"
  },
  "recordings_counts": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  },
  "type": "collection",
  "_create_in_folder": "string"
}

Update 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 parameters

name
string
derived_name
string
description
string
pinned
boolean
deleted
boolean
filters
_create_in_folder
string

Response

Example request

PATCH /api/environments/:project_id/session_recording_playlists/:short_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_recording_playlists/:short_id/\
	-d name="string"

Example response

Status 200

RESPONSE

{
  "id": 0,
  "short_id": "string",
  "name": "string",
  "derived_name": "string",
  "description": "string",
  "pinned": true,
  "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,
  "filters": null,
  "last_modified_at": "2019-08-24T14:15:22Z",
  "last_modified_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"
  },
  "recordings_counts": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  },
  "type": "collection",
  "_create_in_folder": "string"
}

Delete environments session recording playlists

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

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

Example 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/

Example response

Status 405 No response body

Delete environments session recording playlists

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

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

Example 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/

Example 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

Example 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/

Example 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

Example 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/

Example 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
_create_in_folder
string

Example 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"