Warehouse

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

Endpoints

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

List all warehouse expressions

Create, read, update and delete saved HogQL expressions that appear as virtual fields on tables.

Required API key scopes

warehouse_view:read

Query parameters

limit
integer
offset
integer
search
string

Response

Example request

GET /api/projects/:project_id/warehouse_expressions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/warehouse_expressions/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/warehouse_expressions/".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/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "deleted": true,
      "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": {},
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "table_name": "string",
      "field_name": "string",
      "expression": "string",
      "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
    }
  ]
}

Create warehouse expressions

Create, read, update and delete saved HogQL expressions that appear as virtual fields on tables.

Required API key scopes

warehouse_view:write

Request parameters

deleted
boolean | null
table_name
string
field_name
string
expression
string
connection_id
string | null

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "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": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "table_name": "string",
  "field_name": "string",
  "expression": "string",
  "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Retrieve warehouse expressions

Create, read, update and delete saved HogQL expressions that appear as virtual fields on tables.

Required API key scopes

warehouse_view:read

Path parameters

id
string

Response

Example request

GET /api/projects/:project_id/warehouse_expressions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/warehouse_expressions/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/warehouse_expressions/{warehouse_expression_id}/".format(
        project_id=project_id,
		warehouse_expression_id="<the warehouse expression id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "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": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "table_name": "string",
  "field_name": "string",
  "expression": "string",
  "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Update warehouse expressions

Create, read, update and delete saved HogQL expressions that appear as virtual fields on tables.

Required API key scopes

warehouse_view:write

Path parameters

id
string

Request parameters

deleted
boolean | null
table_name
string
field_name
string
expression
string
connection_id
string | null

Response

Example request

PATCH /api/projects/:project_id/warehouse_expressions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/warehouse_expressions/:id/\
	-d deleted="boolean"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/warehouse_expressions/{warehouse_expression_id}/".format(
        project_id=project_id,
		warehouse_expression_id="<the warehouse expression id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"deleted": "boolean"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "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": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "table_name": "string",
  "field_name": "string",
  "expression": "string",
  "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Delete warehouse expressions

Create, read, update and delete saved HogQL expressions that appear as virtual fields on tables.

Required API key scopes

warehouse_view:write

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/warehouse_expressions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/warehouse_expressions/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/warehouse_expressions/{warehouse_expression_id}/".format(
        project_id=project_id,
		warehouse_expression_id="<the warehouse expression id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Warehouse

Endpoints

List all warehouse expressions

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Create warehouse expressions

Required API key scopes

Request parameters

Response

Example request

Example response

Status 201

Retrieve warehouse expressions

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update warehouse expressions

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete warehouse expressions

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body