Environments-7
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
Update environments error tracking suppression rules
Required API key scopes
error_tracking:write
Path parameters
- idstring
A UUID string identifying this error tracking suppression rule.
- 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
- filters
- order_keyinteger
Response
Request
PATCH
/api /environments /:project_id /error_tracking /suppression_rules /: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/error_tracking/suppression_rules/:id/\-d filters=undefined
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","filters": null,"order_key": -2147483648}
Update environments error tracking suppression rules
Required API key scopes
error_tracking:write
Path parameters
- idstring
A UUID string identifying this error tracking suppression rule.
- 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
- filters
- order_keyinteger
Response
Request
PATCH
/api /environments /:project_id /error_tracking /suppression_rules /: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/error_tracking/suppression_rules/:id/\-d filters=undefined
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","filters": null,"order_key": -2147483648}
Delete environments error tracking suppression rules
Required API key scopes
error_tracking:write
Path parameters
- idstring
A UUID string identifying this error tracking suppression rule.
- 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 /error_tracking /suppression_rules /: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/error_tracking/suppression_rules/:id/
Response
Status 204 No response body
Delete environments error tracking suppression rules
Required API key scopes
error_tracking:write
Path parameters
- idstring
A UUID string identifying this error tracking suppression rule.
- 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 /error_tracking /suppression_rules /: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/error_tracking/suppression_rules/:id/
Response
Status 204 No response body
List all environments error tracking symbol sets
Required API key scopes
error_tracking: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 /error_tracking /symbol_sets
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/error_tracking/symbol_sets/
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": "497f6eca-6276-4993-bfeb-53cbbbba6f08","ref": "string","team_id": 0,"created_at": "2019-08-24T14:15:22Z","storage_ptr": "string","failure_reason": "string"}]}
List all environments error tracking symbol sets
Required API key scopes
error_tracking: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 /error_tracking /symbol_sets
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/error_tracking/symbol_sets/
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": "497f6eca-6276-4993-bfeb-53cbbbba6f08","ref": "string","team_id": 0,"created_at": "2019-08-24T14:15:22Z","storage_ptr": "string","failure_reason": "string"}]}
Create environments error tracking symbol sets
Required API key scopes
error_tracking: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/.
Response
Request
Response
Status 201
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","ref": "string","team_id": 0,"created_at": "2019-08-24T14:15:22Z","storage_ptr": "string","failure_reason": "string"}
Create environments error tracking symbol sets
Required API key scopes
error_tracking: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/.
Response
Request
Response
Status 201
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","ref": "string","team_id": 0,"created_at": "2019-08-24T14:15:22Z","storage_ptr": "string","failure_reason": "string"}
Retrieve environments error tracking symbol sets
Required API key scopes
error_tracking:read
Path parameters
- idstring
A UUID string identifying this error tracking symbol set.
- 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 /error_tracking /symbol_sets /: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/error_tracking/symbol_sets/:id/
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","ref": "string","team_id": 0,"created_at": "2019-08-24T14:15:22Z","storage_ptr": "string","failure_reason": "string"}
Retrieve environments error tracking symbol sets
Required API key scopes
error_tracking:read
Path parameters
- idstring
A UUID string identifying this error tracking symbol set.
- 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 /error_tracking /symbol_sets /: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/error_tracking/symbol_sets/:id/
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","ref": "string","team_id": 0,"created_at": "2019-08-24T14:15:22Z","storage_ptr": "string","failure_reason": "string"}
Update environments error tracking symbol sets
Required API key scopes
error_tracking:write
Path parameters
- idstring
A UUID string identifying this error tracking symbol set.
- 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
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","ref": "string","team_id": 0,"created_at": "2019-08-24T14:15:22Z","storage_ptr": "string","failure_reason": "string"}
Update environments error tracking symbol sets
Required API key scopes
error_tracking:write
Path parameters
- idstring
A UUID string identifying this error tracking symbol set.
- 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
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","ref": "string","team_id": 0,"created_at": "2019-08-24T14:15:22Z","storage_ptr": "string","failure_reason": "string"}
Delete environments error tracking symbol sets
Required API key scopes
error_tracking:write
Path parameters
- idstring
A UUID string identifying this error tracking symbol set.
- 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 /error_tracking /symbol_sets /: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/error_tracking/symbol_sets/:id/
Response
Status 204 No response body
Delete environments error tracking symbol sets
Required API key scopes
error_tracking:write
Path parameters
- idstring
A UUID string identifying this error tracking symbol set.
- 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 /error_tracking /symbol_sets /: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/error_tracking/symbol_sets/:id/
Response
Status 204 No response body
List all environments events
This endpoint allows you to list and filter events.
It is effectively deprecated and is kept only for backwards compatibility.
If you ever ask about it you will be advised to not use it...
If you want to ad-hoc list or aggregate events, use the Query endpoint instead.
If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.
Required API key scopes
query: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
- afterstring
Only return events with a timestamp after this time.
- beforestring
Only return events with a timestamp before this time.
- distinct_idinteger
Filter list by distinct id.
- eventstring
Filter list by event. For example
user sign up
or$pageview
. - formatstringOne of:
"csv"
"json"
- limitinteger
The maximum number of results to return
- offsetinteger
The initial index from which to return the results.
- person_idinteger
Filter list by person id.
- propertiesarray
Filter events by event property, person property, cohort, groups and more.
- selectarray
(Experimental) JSON-serialized array of HogQL expressions to return
- wherearray
(Experimental) JSON-serialized array of HogQL expressions that must pass
Response
Request
GET
/api /environments /:project_id /events
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/events/
Response
Status 200
{"next": "http://api.example.org/accounts/?offset=400&limit=100","results": [{"id": "string","distinct_id": "string","properties": "string","event": "string","timestamp": "string","person": "string","elements": "string","elements_chain": "string"}]}
List all environments events
This endpoint allows you to list and filter events.
It is effectively deprecated and is kept only for backwards compatibility.
If you ever ask about it you will be advised to not use it...
If you want to ad-hoc list or aggregate events, use the Query endpoint instead.
If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.
Required API key scopes
query: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
- afterstring
Only return events with a timestamp after this time.
- beforestring
Only return events with a timestamp before this time.
- distinct_idinteger
Filter list by distinct id.
- eventstring
Filter list by event. For example
user sign up
or$pageview
. - formatstringOne of:
"csv"
"json"
- limitinteger
The maximum number of results to return
- offsetinteger
The initial index from which to return the results.
- person_idinteger
Filter list by person id.
- propertiesarray
Filter events by event property, person property, cohort, groups and more.
- selectarray
(Experimental) JSON-serialized array of HogQL expressions to return
- wherearray
(Experimental) JSON-serialized array of HogQL expressions that must pass
Response
Request
GET
/api /environments /:project_id /events
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/events/
Response
Status 200
{"next": "http://api.example.org/accounts/?offset=400&limit=100","results": [{"id": "string","distinct_id": "string","properties": "string","event": "string","timestamp": "string","person": "string","elements": "string","elements_chain": "string"}]}
Retrieve environments events
Required API key scopes
query:read
Path parameters
- idstring
- 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
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api /environments /:project_id /events /: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/events/:id/
Response
Status 200
{"id": "string","distinct_id": "string","properties": "string","event": "string","timestamp": "string","person": "string","elements": "string","elements_chain": "string"}
Retrieve environments events
Required API key scopes
query:read
Path parameters
- idstring
- 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
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api /environments /:project_id /events /: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/events/:id/
Response
Status 200
{"id": "string","distinct_id": "string","properties": "string","event": "string","timestamp": "string","person": "string","elements": "string","elements_chain": "string"}