Environments-14
For instructions on how to authenticate to use this endpoint, see API overview.
Generate session recording filters using AI. This is in development and likely to change, you should not depend on this API.
Endpoints
Create environments session recordings ai filters
Path parameters
- project_idstring
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
Request
POST
/api /environments /:project_id /session_recordings /ai /filters
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/ai/filters/\-d distinct_id="string"
Response
Status 200 No response body
Create environments session recordings ai filters
Path parameters
- project_idstring
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
Request
POST
/api /environments /:project_id /session_recordings /ai /filters
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/ai/filters/\-d distinct_id="string"
Response
Status 200 No response body
Create environments session recordings ai regex
Generate regex patterns using AI. This is in development and likely to change, you should not depend on this API.
Path parameters
- project_idstring
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
Request
POST
/api /environments /:project_id /session_recordings /ai /regex
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/ai/regex/\-d distinct_id="string"
Response
Status 200 No response body
Create environments session recordings ai regex
Generate regex patterns using AI. This is in development and likely to change, you should not depend on this API.
Path parameters
- project_idstring
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
Request
POST
/api /environments /:project_id /session_recordings /ai /regex
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/ai/regex/\-d distinct_id="string"
Response
Status 200 No response body
Retrieve environments sessions property definitions
Path parameters
- project_idstring
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
Path parameters
- project_idstring
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 values
Path parameters
- project_idstring
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 /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/
Response
Status 200 No response body
Retrieve environments sessions values
Path parameters
- project_idstring
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 /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/
Response
Status 200 No response body
List all environments subscriptions
Required API key scopes
subscription:read
Path parameters
- project_idstring
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
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
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/
Response
Status 200
{"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"}]}
List all environments subscriptions
Required API key scopes
subscription:read
Path parameters
- project_idstring
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
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
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/
Response
Status 200
{"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_idstring
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
- dashboardinteger
- insightinteger
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- invite_messagestring
Response
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"
Response
Status 201
{"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_idstring
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
- dashboardinteger
- insightinteger
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- invite_messagestring
Response
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"
Response
Status 201
{"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
- idinteger
A unique integer value identifying this subscription.
- project_idstring
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 /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/
Response
Status 200
{"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
- idinteger
A unique integer value identifying this subscription.
- project_idstring
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 /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/
Response
Status 200
{"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
- idinteger
A unique integer value identifying this subscription.
- project_idstring
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
- dashboardinteger
- insightinteger
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- invite_messagestring
Response
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"
Response
Status 200
{"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
- idinteger
A unique integer value identifying this subscription.
- project_idstring
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
- dashboardinteger
- insightinteger
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- invite_messagestring
Response
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"
Response
Status 200
{"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
- idinteger
A unique integer value identifying this subscription.
- project_idstring
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 /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/
Response
Status 405 No response body
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
- idinteger
A unique integer value identifying this subscription.
- project_idstring
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 /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/