Data API Reference

Data

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

Endpoints

`GET`
`GET`
`GET`
`GET`
`GET`
`GET`
`GET`
`GET`
`POST`
`GET`
`GET`
`POST`
`POST`
`GET`
`GET`
`GET`
`GET`
`POST`
`GET`

List all environments data modeling jobs

List data modeling jobs which are "runs" for our saved queries.

Required API key scopes

warehouse_view:read

Query parameters

cursor
string
limit
integer
saved_query_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "saved_query_id": "841a020c-dad2-4bac-a071-aaf3f5af0641",
      "status": "Cancelled",
      "rows_materialized": 0,
      "error": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "last_run_at": "2019-08-24T14:15:22Z",
      "workflow_id": "string",
      "workflow_run_id": "string",
      "rows_expected": 0
    }
  ]
}

Retrieve environments data modeling jobs

List data modeling jobs which are "runs" for our saved queries.

Required API key scopes

warehouse_view:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "saved_query_id": "841a020c-dad2-4bac-a071-aaf3f5af0641",
  "status": "Cancelled",
  "rows_materialized": 0,
  "error": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "last_run_at": "2019-08-24T14:15:22Z",
  "workflow_id": "string",
  "workflow_run_id": "string",
  "rows_expected": 0
}

Retrieve environments data modeling jobs recent

Get the most recent non-running job for each saved query from the v2 backend.

Response

Example request

GET /api/environments/:environment_id/data_modeling_jobs/recent
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/data_modeling_jobs/recent/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/data_modeling_jobs/recent/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "saved_query_id": "841a020c-dad2-4bac-a071-aaf3f5af0641",
  "status": "Cancelled",
  "rows_materialized": 0,
  "error": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "last_run_at": "2019-08-24T14:15:22Z",
  "workflow_id": "string",
  "workflow_run_id": "string",
  "rows_expected": 0
}

Retrieve environments data modeling jobs running

Get all currently running jobs from the v2 backend.

Response

Example request

GET /api/environments/:environment_id/data_modeling_jobs/running
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/data_modeling_jobs/running/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/data_modeling_jobs/running/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "saved_query_id": "841a020c-dad2-4bac-a071-aaf3f5af0641",
  "status": "Cancelled",
  "rows_materialized": 0,
  "error": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "last_run_at": "2019-08-24T14:15:22Z",
  "workflow_id": "string",
  "workflow_run_id": "string",
  "rows_expected": 0
}

Retrieve environments data warehouse check database name

Check if a database name is available.

Query parameters

name
string

Response

Example request

GET /api/environments/:environment_id/data_warehouse/check-database-name
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/data_warehouse/check-database-name/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/data_warehouse/check-database-name/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "name": "string",
  "available": true
}

Retrieve environments data warehouse completed activity

Returns completed/non-running activities (jobs with status 'Completed'). Supports pagination and cutoff time filtering.

Example request

GET /api/environments/:environment_id/data_warehouse/completed_activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/data_warehouse/completed_activity/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/data_warehouse/completed_activity/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments data warehouse data health issues

Also available via the PostHog MCP server:
data-warehouse-data-health-issues-retrieve — List data pipeline health issues

Returns failed/disabled data pipeline items for the Pipeline status side panel. Includes: materializations, syncs, sources, destinations, and transformations.

Example request

GET /api/environments/:environment_id/data_warehouse/data_health_issues
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/data_warehouse/data_health_issues/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/data_warehouse/data_health_issues/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments data warehouse data ops dashboard

Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet.

Required API key scopes

warehouse_view:write

Example request

GET /api/environments/:environment_id/data_warehouse/data_ops_dashboard
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/data_warehouse/data_ops_dashboard/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/data_warehouse/data_ops_dashboard/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create environments data warehouse deprovision

Start deprovisioning the managed warehouse for this team.

Required API key scopes

warehouse_view:write

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "status": "string",
  "team": "string"
}

Retrieve environments data warehouse job stats

Returns success and failed job statistics for the last 1, 7, or 30 days. Query parameter 'days' can be 1, 7, or 30 (default: 7).

Example request

GET /api/environments/:environment_id/data_warehouse/job_stats
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/data_warehouse/job_stats/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/data_warehouse/job_stats/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments data warehouse property values

API endpoints for data warehouse aggregate statistics and operations.

Required API key scopes

query:read

Example request

GET /api/environments/:environment_id/data_warehouse/property_values
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/data_warehouse/property_values/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/data_warehouse/property_values/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create environments data warehouse provision

Start provisioning a managed warehouse for this team.

Required API key scopes

warehouse_view:write

Request parameters

database_name
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "status": "string",
  "team": "string"
}

Create environments data warehouse reset password

Reset the root password for the managed warehouse.

Required API key scopes

warehouse_view:write

Response

Example request

POST /api/environments/:environment_id/data_warehouse/reset-password
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/:environment_id/data_warehouse/reset-password/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/data_warehouse/reset-password/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "username": "string",
  "password": "string"
}

Retrieve environments data warehouse running activity

Returns currently running activities (jobs with status 'Running'). Supports pagination and cutoff time filtering.

Example request

GET /api/environments/:environment_id/data_warehouse/running_activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/data_warehouse/running_activity/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/data_warehouse/running_activity/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments data warehouse total rows stats

Returns aggregated statistics for the data warehouse total rows processed within the current billing period. Used by the frontend data warehouse scene to display usage information.

Example request

GET /api/environments/:environment_id/data_warehouse/total_rows_stats
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/data_warehouse/total_rows_stats/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/data_warehouse/total_rows_stats/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments data warehouse warehouse status

Get the current provisioning status of the managed warehouse.

Response

Example request

GET /api/environments/:environment_id/data_warehouse/warehouse_status
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/data_warehouse/warehouse_status/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/data_warehouse/warehouse_status/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "team_name": "string",
  "state": "pending",
  "status_message": "string",
  "ready_at": "2019-08-24T14:15:22Z",
  "failed_at": "2019-08-24T14:15:22Z"
}

List all environments external data schemas

Also available via the PostHog MCP server:
external-data-schemas-list — List data import schemas

Required API key scopes

external_data_source:read

Query parameters

limit
integer
offset
integer
search
string

Response

Example request

GET /api/environments/:environment_id/external_data_schemas
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/external_data_schemas/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/external_data_schemas/".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",
      "name": "string",
      "label": "string",
      "table": {},
      "should_sync": true,
      "last_synced_at": "2019-08-24T14:15:22Z",
      "latest_error": "string",
      "incremental": true,
      "status": "string",
      "sync_type": "full_refresh",
      "incremental_field": "string",
      "incremental_field_type": "integer",
      "sync_frequency": "never",
      "sync_time_of_day": "14:15:22Z",
      "description": "string",
      "primary_key_columns": [
        "string"
      ],
      "cdc_table_mode": "consolidated",
      "enabled_columns": [
        "string"
      ],
      "available_columns": [
        {
          "name": "string",
          "data_type": "string",
          "is_nullable": true
        }
      ]
    }
  ]
}

Create environments external data schemas

Required API key scopes

external_data_source:write

Request parameters

should_sync
boolean
sync_type
incremental_field
stringnull
incremental_field_type
sync_frequency
sync_time_of_day
stringnull
primary_key_columns
arraynull
cdc_table_mode
enabled_columns
arraynull

Response

Example request

POST /api/environments/:environment_id/external_data_schemas
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/:environment_id/external_data_schemas/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/external_data_schemas/".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",
  "name": "string",
  "label": "string",
  "table": {},
  "should_sync": true,
  "last_synced_at": "2019-08-24T14:15:22Z",
  "latest_error": "string",
  "incremental": true,
  "status": "string",
  "sync_type": "full_refresh",
  "incremental_field": "string",
  "incremental_field_type": "integer",
  "sync_frequency": "never",
  "sync_time_of_day": "14:15:22Z",
  "description": "string",
  "primary_key_columns": [
    "string"
  ],
  "cdc_table_mode": "consolidated",
  "enabled_columns": [
    "string"
  ],
  "available_columns": [
    {
      "name": "string",
      "data_type": "string",
      "is_nullable": true
    }
  ]
}

Retrieve environments external data schemas

Also available via the PostHog MCP server:
external-data-schemas-retrieve — Get data import schema

Required API key scopes

external_data_source:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "label": "string",
  "table": {},
  "should_sync": true,
  "last_synced_at": "2019-08-24T14:15:22Z",
  "latest_error": "string",
  "incremental": true,
  "status": "string",
  "sync_type": "full_refresh",
  "incremental_field": "string",
  "incremental_field_type": "integer",
  "sync_frequency": "never",
  "sync_time_of_day": "14:15:22Z",
  "description": "string",
  "primary_key_columns": [
    "string"
  ],
  "cdc_table_mode": "consolidated",
  "enabled_columns": [
    "string"
  ],
  "available_columns": [
    {
      "name": "string",
      "data_type": "string",
      "is_nullable": true
    }
  ]
}