Data

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

Endpoints

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

Retrieve data warehouse check database name

Check if a database name is available.

Query parameters

name
string

Response

Example request

GET /api/projects/:project_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/projects/:project_id/data_warehouse/check-database-name/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_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 data warehouse check schema name

Check if a schema name is free within the organization's managed warehouse.

Query parameters

name
string

Response

Example request

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

Example response

Status 200

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

Retrieve data warehouse completed activity

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

Query parameters

cutoff_days
integer
Default: 30
kind
string
Default: all
One of: "all""import""model"
limit
integer
Default: 20
offset
integer
Default: 0
outcome
string
Default: completed
One of: "completed""failed""all"

Response

Example request

GET /api/projects/:project_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/projects/:project_id/data_warehouse/completed_activity/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/data_warehouse/completed_activity/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "results": [
    {
      "id": "string",
      "type": "string",
      "name": "string",
      "status": "string",
      "rows": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "latest_error": "string",
      "workflow_run_id": "string",
      "origin": "string",
      "source_id": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Status 500 The activity query failed.

RESPONSE
{
  "error": "string"
}

Retrieve data warehouse data health issues

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

Required API key scopes

warehouse_view:readexternal_data_source:readbatch_export:readhog_function:read

Response

Example request

GET /api/projects/:project_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/projects/:project_id/data_warehouse/data_health_issues/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/data_warehouse/data_health_issues/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "results": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "source_type": "string",
      "sync_type": "string",
      "status": "string",
      "error": "string",
      "failed_at": "2019-08-24T14:15:22Z",
      "url": "string"
    }
  ],
  "count": 0
}

Status 500 The health query failed.

RESPONSE
{
  "error": "string"
}

Retrieve 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/projects/:project_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/projects/:project_id/data_warehouse/data_ops_dashboard/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_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

Retrieve data warehouse data quality gate

Read or update the team's data quality gate: whether a materialization whose error-severity checks fail is published.

Required API key scopes

warehouse_view:write

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "gate_materialization_on_checks": true
}

Update data warehouse data quality gate

Read or update the team's data quality gate: whether a materialization whose error-severity checks fail is published.

Required API key scopes

warehouse_view:write

Request parameters

gate_materialization_on_checks
boolean

Response

Example request

PATCH /api/projects/:project_id/data_warehouse/data_quality_gate
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/data_warehouse/data_quality_gate/\
	-d gate_materialization_on_checks="boolean"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/data_warehouse/data_quality_gate/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"gate_materialization_on_checks": "boolean"
	}
).json()

Example response

Status 200

RESPONSE
{
  "gate_materialization_on_checks": true
}

Delete data warehouse delete org

Remove the organization's provisioning record after teardown, freeing its warehouse name.

Called once the warehouse status reports deleted: deprovision tears the warehouse down, this removes the now-empty org row so the database_name can be reused. Restricted to organization admins.

Required API key scopes

warehouse_view:write

Response

Example request

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

Example response

Status 200

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

Create data warehouse deprovision

Start deprovisioning the organization's managed warehouse. Restricted to organization admins.

Required API key scopes

warehouse_view:write

Response

Example request

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

Example response

Status 202

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

Retrieve 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).

Query parameters

days
integer
Default: 7
One of: "1""7""30"

Response

Example request

GET /api/projects/:project_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/projects/:project_id/data_warehouse/job_stats/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/data_warehouse/job_stats/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "days": 0,
  "cutoff_time": "2019-08-24T14:15:22Z",
  "total_jobs": 0,
  "successful_jobs": 0,
  "failed_jobs": 0,
  "external_data_jobs": {
    "total": 0,
    "running": 0,
    "successful": 0,
    "failed": 0
  },
  "modeling_jobs": {
    "total": 0,
    "running": 0,
    "successful": 0,
    "failed": 0
  },
  "breakdown": {
    "property1": {
      "successful": 0,
      "failed": 0
    },
    "property2": {
      "successful": 0,
      "failed": 0
    }
  }
}

Status 400 `days` was not 1, 7 or 30.

RESPONSE
{
  "error": "string"
}

Status 500 The statistics query failed.

RESPONSE
{
  "error": "string"
}

Retrieve data warehouse managed warehouse data status

Get events, persons, and imported source readiness for the managed warehouse.

Required API key scopes

warehouse_view:readexternal_data_source:read

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "overall_readiness_state": "not_configured",
  "events": {
    "dataset": "events",
    "readiness_state": "not_configured",
    "detail": "string",
    "completed_partitions": 0,
    "total_partitions": 0,
    "current_partition": "string",
    "last_updated_at": "2019-08-24T14:15:22Z"
  },
  "persons": {
    "dataset": "events",
    "readiness_state": "not_configured",
    "detail": "string",
    "completed_partitions": 0,
    "total_partitions": 0,
    "current_partition": "string",
    "last_updated_at": "2019-08-24T14:15:22Z"
  },
  "sources": {
    "readiness_state": "not_configured",
    "detail": "string",
    "sources": [
      {
        "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
        "source_name": "string",
        "source_type": "string",
        "readiness_state": "not_configured",
        "detail": "string",
        "total_schemas": 0,
        "applied_schemas": 0,
        "last_applied_at": "2019-08-24T14:15:22Z",
        "last_synced_at": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "generated_at": "2019-08-24T14:15:22Z"
}

Retrieve data warehouse managed warehouse monitoring

Get tenant-safe live worker, session, queue, and capacity data for the current organization.

Required API key scopes

warehouse_view:read

Response

Example request

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

Example response

Status 200 Current organization-scoped worker and query activity.

RESPONSE
{
  "schema_version": 1,
  "org_id": "string",
  "as_of": "2019-08-24T14:15:22Z",
  "warehouse": {
    "state": "string"
  },
  "limits": {
    "max_workers": 0,
    "max_vcpus": 0,
    "default_worker_cpu": "string",
    "default_worker_memory": "string",
    "default_worker_ttl_seconds": 0,
    "default_worker_min_hot_idle": 0
  },
  "totals": {
    "workers": 0,
    "allocated_cpu_cores": 0.1,
    "allocated_memory_bytes": 0,
    "active_sessions": 0,
    "running_queries": 0,
    "queued_connections": 0
  },
  "workers": [
    {
      "id": "string",
      "state": "string",
      "cpu": "string",
      "memory": "string",
      "ttl_seconds": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "last_heartbeat_at": "2019-08-24T14:15:22Z",
      "session": {
        "protocol": "string",
        "state": "string",
        "elapsed_ms": 0,
        "percentage": 0,
        "rows": 0,
        "total_rows": 0,
        "stalled": true
      }
    }
  ],
  "coverage": {
    "cp_responders": 0,
    "cp_total": 0,
    "partial": true
  }
}

Status 400 The monitoring query parameters are invalid.

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

Status 403 Managed warehouse monitoring is not available to the caller.

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

Status 404 The organization does not have a managed warehouse.

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

Status 501 Managed warehouse monitoring is not configured.

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

Status 502 The managed warehouse monitoring service returned an invalid response or was unreachable.

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

Status 504 The managed warehouse monitoring service timed out.

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

Retrieve data warehouse managed warehouse monitoring timeseries

Get one allow-listed monitoring metric for the current organization and trailing time window.

Required API key scopes

warehouse_view:read

Query parameters

metric
string
One of: "query_rate""error_ratio""duration_p50""duration_p95""sessions_active""acquire_p95""acquire_by_source""storage_bytes""worker_crash_rate"
window
string
Default: 24h
One of: "1h""6h""24h""7d""30d"

Response

Example request

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

Example response

Status 200 One organization-scoped monitoring metric over time.

RESPONSE
{
  "schema_version": 1,
  "org_id": "string",
  "metric": "string",
  "unit": "string",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "step_seconds": 1,
  "series": [
    {
      "labels": {
        "property1": "string",
        "property2": "string"
      },
      "points": [
        {
          "timestamp": "2019-08-24T14:15:22Z",
          "value": 0.1
        }
      ]
    }
  ]
}

Status 400 The monitoring query parameters are invalid.

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

Status 403 Managed warehouse monitoring is not available to the caller.

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

Status 404 The organization does not have a managed warehouse.

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

Status 501 Managed warehouse monitoring is not configured.

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

Status 502 The managed warehouse monitoring service returned an invalid response or was unreachable.

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

Status 504 The managed warehouse monitoring service timed out.

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

Retrieve data warehouse managed warehouse source schemas

Per-schema backfill and live import status for one source, for the Overview tab's drill-down modal — the main status endpoint only returns a per-source rollup.

Required API key scopes

warehouse_view:readexternal_data_source:read

Query parameters

source_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "schemas": [
    {
      "schema_id": "9c37f32d-8308-4815-9b0d-83fa3c1b25f9",
      "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
      "source_name": "string",
      "source_type": "string",
      "table_name": "string",
      "readiness_state": "not_configured",
      "detail": "string",
      "workflow_type": "copy",
      "workflow_status": "running",
      "workflow_started_at": "2019-08-24T14:15:22Z",
      "applied": true,
      "last_applied_at": "2019-08-24T14:15:22Z",
      "last_synced_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create data warehouse onboard team

Onboard this project onto the organization's existing managed warehouse.

Requires a schema name and records the project's membership in the Duckgres control plane. Restricted to organization admins.

Required API key scopes

warehouse_view:write

Request parameters

schema_name
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "onboarded": true,
  "schema_name": "string"
}

Retrieve data warehouse property values

API endpoints for data warehouse aggregate statistics and operations.

Required API key scopes

query:read

Example request

GET /api/projects/:project_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/projects/:project_id/data_warehouse/property_values/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_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 data warehouse provision

Start provisioning a managed warehouse for this organization (shared by all its teams).

Required API key scopes

warehouse_view:write

Request parameters

database_name
string
schema_name
string

Response

Example request

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

Example response

Status 202

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

Create data warehouse reset password

Reset the root password for the managed warehouse.

Required API key scopes

warehouse_view:write

Response

Example request

POST /api/projects/:project_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/projects/:project_id/data_warehouse/reset-password/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_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 data warehouse running activity

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

Query parameters

cutoff_days
integer
Default: 30
kind
string
Default: all
One of: "all""import""model"
limit
integer
Default: 20
offset
integer
Default: 0

Response

Example request

GET /api/projects/:project_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/projects/:project_id/data_warehouse/running_activity/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/data_warehouse/running_activity/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "results": [
    {
      "id": "string",
      "type": "string",
      "name": "string",
      "status": "string",
      "rows": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "latest_error": "string",
      "workflow_run_id": "string",
      "origin": "string",
      "source_id": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Status 500 The activity query failed.

RESPONSE
{
  "error": "string"
}

Retrieve 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.

Response

Example request

GET /api/projects/:project_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/projects/:project_id/data_warehouse/total_rows_stats/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/data_warehouse/total_rows_stats/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "billing_available": true,
  "billing_interval": "string",
  "billing_period_start": "2019-08-24T14:15:22Z",
  "billing_period_end": "2019-08-24T14:15:22Z",
  "total_rows": 0,
  "tracked_billing_rows": 0,
  "pending_billing_rows": 0,
  "materialized_rows_in_billing_period": 0,
  "breakdown_of_rows_by_source": {
    "property1": 0,
    "property2": 0
  }
}

Status 500 Billing could not be reached.

RESPONSE
{
  "error": "string"
}