Environments-24 API Reference

Environments-24

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

Endpoints

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

Create environments user interviews

Required API key scopes

user_interview_DO_NOT_USE:write

Path parameters

project_id
string

Request parameters

interviewee_emails
array
summary
string
audio
string

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "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

id
string
project_id
string

Response

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

Example response

Status 200

RESPONSE
{
  "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

id
string
project_id
string

Request parameters

interviewee_emails
array
summary
string
audio
string

Response

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

Example response

Status 200

RESPONSE
{
  "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

id
string
project_id
string

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

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

Query parameters

page
integer
search
string

Response

Example 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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/warehouse_saved_queries/".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/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "deleted": true,
      "name": "string",
      "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",
      "managed_viewset_kind": "string",
      "latest_error": "string",
      "is_materialized": true,
      "origin": "data_warehouse"
    }
  ]
}

Create environments warehouse saved queries

Create, Read, Update and Delete Warehouse Tables.

Required API key scopes

warehouse_view:write

Path parameters

project_id
string

Request parameters

deleted
boolean
name
string
query
edited_history_id
string
soft_update
boolean

Response

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

Example response

Status 201

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Retrieve environments warehouse saved queries

Create, Read, Update and Delete Warehouse Tables.

Required API key scopes

warehouse_view:read

Path parameters

id
string
project_id
string

Response

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

Example response

Status 200

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Update environments warehouse saved queries

Create, Read, Update and Delete Warehouse Tables.

Required API key scopes

warehouse_view:write

Path parameters

id
string
project_id
string

Request parameters

deleted
boolean
name
string
query
edited_history_id
string
soft_update
boolean

Response

Example 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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/warehouse_saved_queries/{environments-24_id}/".format(
        project_id=project_id,
		environments-24_id="<the environments-24 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"deleted": "boolean"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Delete environments warehouse saved queries

Create, Read, Update and Delete Warehouse Tables.

Required API key scopes

warehouse_view:write

Path parameters

id
string
project_id
string

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

Example response

Status 204 No response body

Retrieve environments warehouse saved queries activity

Create, Read, Update and Delete Warehouse Tables.

Required API key scopes

activity_log:read

Path parameters

id
string
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries ancestors

Return the ancestors of this saved query.

By default, we return the immediate parents. The level parameter can be used to look further back into the ancestor tree. If level overshoots (i.e. points to only ancestors beyond the root), we return an empty list.

Path parameters

id
string
project_id
string

Request parameters

deleted
boolean
name
string
query
edited_history_id
string
soft_update
boolean

Response

Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/ancestors
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/:id/ancestors/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/warehouse_saved_queries/{environments-24_id}/ancestors/".format(
        project_id=project_id,
		environments-24_id="<the environments-24 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries cancel

Cancel a running saved query workflow.

Path parameters

id
string
project_id
string

Request parameters

deleted
boolean
name
string
query
edited_history_id
string
soft_update
boolean

Response

Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/cancel
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/:id/cancel/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/warehouse_saved_queries/{environments-24_id}/cancel/".format(
        project_id=project_id,
		environments-24_id="<the environments-24 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Retrieve environments warehouse saved queries dependencies

Return the count of immediate upstream and downstream dependencies for this saved query.

Path parameters

id
string
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries descendants

Return the descendants of this saved query.

By default, we return the immediate children. The level parameter can be used to look further ahead into the descendants tree. If level overshoots (i.e. points to only descendants further than a leaf), we return an empty list.

Path parameters

id
string
project_id
string

Request parameters

deleted
boolean
name
string
query
edited_history_id
string
soft_update
boolean

Response

Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/descendants
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/:id/descendants/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/warehouse_saved_queries/{environments-24_id}/descendants/".format(
        project_id=project_id,
		environments-24_id="<the environments-24 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries materialize

Enable materialization for this saved query with a 24-hour sync frequency.

Path parameters

id
string
project_id
string

Request parameters

deleted
boolean
name
string
query
edited_history_id
string
soft_update
boolean

Response

Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/materialize
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/:id/materialize/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/warehouse_saved_queries/{environments-24_id}/materialize/".format(
        project_id=project_id,
		environments-24_id="<the environments-24 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries revert materialization

Undo materialization, revert back to the original view. (i.e. delete the materialized table and the schedule)

Path parameters

id
string
project_id
string

Request parameters

deleted
boolean
name
string
query
edited_history_id
string
soft_update
boolean

Response

Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/revert_materialization
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/:id/revert_materialization/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/warehouse_saved_queries/{environments-24_id}/revert_materialization/".format(
        project_id=project_id,
		environments-24_id="<the environments-24 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries run

Run this saved query.

Path parameters

id
string
project_id
string

Request parameters

deleted
boolean
name
string
query
edited_history_id
string
soft_update
boolean

Response

Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/run
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/:id/run/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/warehouse_saved_queries/{environments-24_id}/run/".format(
        project_id=project_id,
		environments-24_id="<the environments-24 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Retrieve environments warehouse saved queries run history

Return the recent run history (up to 5 most recent) for this materialized view.

Path parameters

id
string
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "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",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}