Warehouse Model API Reference

Warehouse Model

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

Endpoints

`GET`
`GET`

List all warehouse model paths

Required API key scopes

warehouse_view:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/warehouse_model_paths
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_model_paths/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/warehouse_model_paths/".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",
      "path": [
        "string"
      ],
      "team": 0,
      "table": "07ef5ba8-1af0-4779-8f89-822f61a5c62a",
      "saved_query": "e3652b9e-1a82-4fa6-9330-52b013787fcc",
      "created_at": "2019-08-24T14:15:22Z",
      "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"
      },
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Retrieve warehouse model paths

Required API key scopes

warehouse_view:read

Path parameters

id
string

Response

Example request

GET /api/projects/:project_id/warehouse_model_paths/: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_model_paths/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/warehouse_model_paths/{warehouse_model_path_id}/".format(
        project_id=project_id,
		warehouse_model_path_id="<the warehouse model path id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": [
    "string"
  ],
  "team": 0,
  "table": "07ef5ba8-1af0-4779-8f89-822f61a5c62a",
  "saved_query": "e3652b9e-1a82-4fa6-9330-52b013787fcc",
  "created_at": "2019-08-24T14:15:22Z",
  "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"
  },
  "updated_at": "2019-08-24T14:15:22Z"
}

Warehouse Model

Endpoints

List all warehouse model paths

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Retrieve warehouse model paths

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Community questions