Warehouse View

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

Endpoints

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

List all warehouse view links

Create, Read, Update and Delete View Columns.

Required API key scopes

warehouse_view:read

Query parameters

limit
integer
offset
integer
search
string

Response

Example request

GET /api/projects/:project_id/warehouse_view_links
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_view_links/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/warehouse_view_links/".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",
      "source_table_name": "string",
      "source_table_key": "string",
      "joining_table_name": "string",
      "joining_table_key": "string",
      "field_name": "string",
      "configuration": null
    }
  ]
}

Create warehouse view links

Create, Read, Update and Delete View Columns.

Required API key scopes

warehouse_view:write

Request parameters

deleted
boolean | null
source_table_name
string
source_table_key
string
joining_table_name
string
joining_table_key
string
field_name
string
configuration

Response

Example request

POST /api/projects/:project_id/warehouse_view_links
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_view_links/\
	-d source_table_name="string",\
	-d source_table_key="string",\
	-d joining_table_name="string",\
	-d joining_table_key="string",\
	-d field_name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/warehouse_view_links/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"source_table_name": "string",
		"source_table_key": "string",
		"joining_table_name": "string",
		"joining_table_key": "string",
		"field_name": "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",
  "source_table_name": "string",
  "source_table_key": "string",
  "joining_table_name": "string",
  "joining_table_key": "string",
  "field_name": "string",
  "configuration": null
}

Retrieve warehouse view links

Create, Read, Update and Delete View Columns.

Required API key scopes

warehouse_view:read

Path parameters

id
string

Response

Example request

GET /api/projects/:project_id/warehouse_view_links/: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_view_links/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/warehouse_view_links/{warehouse_view_link_id}/".format(
        project_id=project_id,
		warehouse_view_link_id="<the warehouse view link 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",
  "source_table_name": "string",
  "source_table_key": "string",
  "joining_table_name": "string",
  "joining_table_key": "string",
  "field_name": "string",
  "configuration": null
}

Update warehouse view links

Create, Read, Update and Delete View Columns.

Required API key scopes

warehouse_view:write

Path parameters

id
string

Request parameters

deleted
boolean | null
source_table_name
string
source_table_key
string
joining_table_name
string
joining_table_key
string
field_name
string
configuration

Response

Example request

PATCH /api/projects/:project_id/warehouse_view_links/: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_view_links/: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_view_links/{warehouse_view_link_id}/".format(
        project_id=project_id,
		warehouse_view_link_id="<the warehouse view link 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",
  "source_table_name": "string",
  "source_table_key": "string",
  "joining_table_name": "string",
  "joining_table_key": "string",
  "field_name": "string",
  "configuration": null
}

Delete warehouse view links

Create, Read, Update and Delete View Columns.

Required API key scopes

warehouse_view:write

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/warehouse_view_links/: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_view_links/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/warehouse_view_links/{warehouse_view_link_id}/".format(
        project_id=project_id,
		warehouse_view_link_id="<the warehouse view link id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Create warehouse view links validate

Create, Read, Update and Delete View Columns.

Request parameters

joining_table_name
string
joining_table_key
string
source_table_name
string
source_table_key
string

Response

Example request

POST /api/projects/:project_id/warehouse_view_links/validate
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_view_links/validate/\
	-d joining_table_name="string",\
	-d joining_table_key="string",\
	-d source_table_name="string",\
	-d source_table_key="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/warehouse_view_links/validate/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"joining_table_name": "string",
		"joining_table_key": "string",
		"source_table_name": "string",
		"source_table_key": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "is_valid": true,
  "msg": "string",
  "hogql": "string",
  "columns": [
    "string"
  ],
  "results": [
    [
      null
    ]
  ],
  "total_rows": 0,
  "matched_rows": 0,
  "match_rate": 0
}

Status 400 The join does not compile or reference valid fields.

RESPONSE
{
  "attr": "string",
  "code": "string",
  "detail": "string",
  "type": "string",
  "hogql": "string"
}

Status 500 Validation failed with an internal query error.

RESPONSE
{
  "attr": "string",
  "code": "string",
  "detail": "string",
  "type": "string",
  "hogql": "string"
}