Environments-21
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
Retrieve environments user interviews
Required API key scopes
user_interview_DO_NOT_USE:read
Path parameters
- idstring
A UUID string identifying this user interview.
- 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 /user_interviews /: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/user_interviews/:id/
Response
Status 200
{"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"}
Retrieve environments user interviews
Required API key scopes
user_interview_DO_NOT_USE:read
Path parameters
- idstring
A UUID string identifying this user interview.
- 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 /user_interviews /: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/user_interviews/:id/
Response
Status 200
{"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"}
Update environments user interviews
Required API key scopes
user_interview_DO_NOT_USE:write
Path parameters
- idstring
A UUID string identifying this user interview.
- 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
- interviewee_emailsarray
- summarystring
- audiostring
Response
Request
PATCH
/api /environments /:project_id /user_interviews /: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/user_interviews/:id/\-d created_by=undefined
Response
Status 200
{"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"}
Update environments user interviews
Required API key scopes
user_interview_DO_NOT_USE:write
Path parameters
- idstring
A UUID string identifying this user interview.
- 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
- interviewee_emailsarray
- summarystring
- audiostring
Response
Request
PATCH
/api /environments /:project_id /user_interviews /: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/user_interviews/:id/\-d created_by=undefined
Response
Status 200
{"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 environments user interviews
Required API key scopes
user_interview_DO_NOT_USE:write
Path parameters
- idstring
A UUID string identifying this user interview.
- 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 /user_interviews /: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/user_interviews/:id/
Response
Status 204 No response body
Delete environments user interviews
Required API key scopes
user_interview_DO_NOT_USE:write
Path parameters
- idstring
A UUID string identifying this user interview.
- 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 /user_interviews /: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/user_interviews/:id/
Response
Status 204 No response body
List all environments warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view: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
- pageinteger
A page number within the paginated result set.
- searchstring
A search term.
Response
Request
GET
/api /environments /:project_id /warehouse_saved_queries
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/warehouse_saved_queries/
Response
Status 200
{"count": 123,"next": "http://api.example.org/accounts/?page=4","previous": "http://api.example.org/accounts/?page=2","results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","deleted": true,"name": "string","query": null,"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","sync_frequency": "string","columns": "string","status": "Cancelled","last_run_at": "2019-08-24T14:15:22Z","latest_error": "string","edited_history_id": "string","latest_history_id": "string","soft_update": true}]}
List all environments warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view: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
- pageinteger
A page number within the paginated result set.
- searchstring
A search term.
Response
Request
GET
/api /environments /:project_id /warehouse_saved_queries
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/warehouse_saved_queries/
Response
Status 200
{"count": 123,"next": "http://api.example.org/accounts/?page=4","previous": "http://api.example.org/accounts/?page=2","results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","deleted": true,"name": "string","query": null,"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","sync_frequency": "string","columns": "string","status": "Cancelled","last_run_at": "2019-08-24T14:15:22Z","latest_error": "string","edited_history_id": "string","latest_history_id": "string","soft_update": true}]}
Create environments warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view: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
- deletedboolean
- namestring
- query
HogQL query
- edited_history_idstring
- soft_updateboolean
Response
Request
POST
/api /environments /:project_id /warehouse_saved_queries
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/warehouse_saved_queries/\-d name="string"
Response
Status 201
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","deleted": true,"name": "string","query": null,"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","sync_frequency": "string","columns": "string","status": "Cancelled","last_run_at": "2019-08-24T14:15:22Z","latest_error": "string","edited_history_id": "string","latest_history_id": "string","soft_update": true}
Create environments warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view: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
- deletedboolean
- namestring
- query
HogQL query
- edited_history_idstring
- soft_updateboolean
Response
Request
POST
/api /environments /:project_id /warehouse_saved_queries
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/warehouse_saved_queries/\-d name="string"
Response
Status 201
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","deleted": true,"name": "string","query": null,"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","sync_frequency": "string","columns": "string","status": "Cancelled","last_run_at": "2019-08-24T14:15:22Z","latest_error": "string","edited_history_id": "string","latest_history_id": "string","soft_update": true}
Retrieve environments warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view:read
Path parameters
- idstring
A UUID string identifying this data warehouse saved query.
- 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 /warehouse_saved_queries /: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/warehouse_saved_queries/:id/
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","deleted": true,"name": "string","query": null,"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","sync_frequency": "string","columns": "string","status": "Cancelled","last_run_at": "2019-08-24T14:15:22Z","latest_error": "string","edited_history_id": "string","latest_history_id": "string","soft_update": true}
Retrieve environments warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view:read
Path parameters
- idstring
A UUID string identifying this data warehouse saved query.
- 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 /warehouse_saved_queries /: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/warehouse_saved_queries/:id/
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","deleted": true,"name": "string","query": null,"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","sync_frequency": "string","columns": "string","status": "Cancelled","last_run_at": "2019-08-24T14:15:22Z","latest_error": "string","edited_history_id": "string","latest_history_id": "string","soft_update": true}
Update environments warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view:write
Path parameters
- idstring
A UUID string identifying this data warehouse saved query.
- 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
- deletedboolean
- namestring
- query
HogQL query
- edited_history_idstring
- soft_updateboolean
Response
Request
PATCH
/api /environments /:project_id /warehouse_saved_queries /: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/warehouse_saved_queries/:id/\-d deleted="boolean"
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","deleted": true,"name": "string","query": null,"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","sync_frequency": "string","columns": "string","status": "Cancelled","last_run_at": "2019-08-24T14:15:22Z","latest_error": "string","edited_history_id": "string","latest_history_id": "string","soft_update": true}
Update environments warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view:write
Path parameters
- idstring
A UUID string identifying this data warehouse saved query.
- 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
- deletedboolean
- namestring
- query
HogQL query
- edited_history_idstring
- soft_updateboolean
Response
Request
PATCH
/api /environments /:project_id /warehouse_saved_queries /: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/warehouse_saved_queries/:id/\-d deleted="boolean"
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","deleted": true,"name": "string","query": null,"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","sync_frequency": "string","columns": "string","status": "Cancelled","last_run_at": "2019-08-24T14:15:22Z","latest_error": "string","edited_history_id": "string","latest_history_id": "string","soft_update": true}
Delete environments warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view:write
Path parameters
- idstring
A UUID string identifying this data warehouse saved query.
- 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 /warehouse_saved_queries /: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/warehouse_saved_queries/:id/
Response
Status 204 No response body
Delete environments warehouse saved queries
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_view:write
Path parameters
- idstring
A UUID string identifying this data warehouse saved query.
- 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 /warehouse_saved_queries /: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/warehouse_saved_queries/:id/