Data API Reference

Data

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

Endpoints

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

Retrieve external data schemas

Required API key scopes

external_data_source:read

Path parameters

id
string
project_id
string

Response

Example request

GET /api/projects/:project_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/projects/:project_id/external_data_schemas/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/external_data_schemas/{data_warehouse-4_id}/".format(
        project_id=project_id,
		data_warehouse-4_id="<the data warehouse-4 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"
}

Update external data schemas

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Request parameters

should_sync
boolean
sync_type
incremental_field
string
incremental_field_type
sync_frequency
sync_time_of_day
string
primary_key_columns
array
cdc_table_mode

Response

Example request

PATCH /api/projects/:project_id/external_data_schemas/: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/external_data_schemas/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/external_data_schemas/{data_warehouse-4_id}/".format(
        project_id=project_id,
		data_warehouse-4_id="<the data warehouse-4 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).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"
}

Delete external data schemas

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Example request

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

Example response

Status 204 No response body

Create external data schemas cancel

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Request parameters

should_sync
boolean
sync_type
incremental_field
string
incremental_field_type
sync_frequency
sync_time_of_day
string
primary_key_columns
array
cdc_table_mode

Example request

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

Example response

Status 200 No response body

Delete external data schemas delete data

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Example request

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

Example response

Status 204 No response body

Create external data schemas incremental fields

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Request parameters

should_sync
boolean
sync_type
incremental_field
string
incremental_field_type
sync_frequency
sync_time_of_day
string
primary_key_columns
array
cdc_table_mode

Example request

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

Example response

Status 200 No response body

Create external data schemas reload

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Request parameters

should_sync
boolean
sync_type
incremental_field
string
incremental_field_type
sync_frequency
sync_time_of_day
string
primary_key_columns
array
cdc_table_mode

Example request

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

Example response

Status 200 No response body

Create external data schemas resync

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Request parameters

should_sync
boolean
sync_type
incremental_field
string
incremental_field_type
sync_frequency
sync_time_of_day
string
primary_key_columns
array
cdc_table_mode

Example request

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

Example response

Status 200 No response body

List all external data sources

Create, Read, Update and Delete External data Sources.

Required API key scopes

external_data_source:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer
search
string

Response

Example request

GET /api/projects/:project_id/external_data_sources
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_sources/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/".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",
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": "string",
      "status": "string",
      "client_secret": "string",
      "account_id": "string",
      "source_type": "Ashby",
      "latest_error": "string",
      "prefix": "string",
      "description": "string",
      "access_method": "warehouse",
      "engine": "duckdb",
      "last_run_at": "string",
      "schemas": [
        {}
      ],
      "job_inputs": null,
      "revenue_analytics_config": {
        "enabled": true,
        "include_invoiceless_charges": true
      },
      "user_access_level": "string",
      "supports_webhooks": true
    }
  ]
}

Create external data sources

Create, Read, Update and Delete External data Sources.

Required API key scopes

external_data_source:write

Path parameters

project_id
string

Request parameters

source_type
payload
object
prefix
string
description
string
access_method
Default: warehouse

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": "string",
  "status": "string",
  "client_secret": "string",
  "account_id": "string",
  "source_type": "Ashby",
  "latest_error": "string",
  "prefix": "string",
  "description": "string",
  "access_method": "warehouse",
  "engine": "duckdb",
  "last_run_at": "string",
  "schemas": [
    {}
  ],
  "job_inputs": null,
  "revenue_analytics_config": {
    "enabled": true,
    "include_invoiceless_charges": true
  },
  "user_access_level": "string",
  "supports_webhooks": true
}

Retrieve external data sources

Create, Read, Update and Delete External data Sources.

Required API key scopes

external_data_source:read

Path parameters

id
string
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": "string",
  "status": "string",
  "client_secret": "string",
  "account_id": "string",
  "source_type": "Ashby",
  "latest_error": "string",
  "prefix": "string",
  "description": "string",
  "access_method": "warehouse",
  "engine": "duckdb",
  "last_run_at": "string",
  "schemas": [
    {}
  ],
  "job_inputs": null,
  "revenue_analytics_config": {
    "enabled": true,
    "include_invoiceless_charges": true
  },
  "user_access_level": "string",
  "supports_webhooks": true
}

Update external data sources

Create, Read, Update and Delete External data Sources.

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Request parameters

client_secret
string
account_id
string
prefix
string
description
string
job_inputs

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": "string",
  "status": "string",
  "client_secret": "string",
  "account_id": "string",
  "source_type": "Ashby",
  "latest_error": "string",
  "prefix": "string",
  "description": "string",
  "access_method": "warehouse",
  "engine": "duckdb",
  "last_run_at": "string",
  "schemas": [
    {}
  ],
  "job_inputs": null,
  "revenue_analytics_config": {
    "enabled": true,
    "include_invoiceless_charges": true
  },
  "user_access_level": "string",
  "supports_webhooks": true
}

Delete external data sources

Create, Read, Update and Delete External data Sources.

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Example request

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

Example response

Status 204 No response body

Update external data sources bulk update schemas

Create, Read, Update and Delete External data Sources.

Path parameters

id
string
project_id
string

Query parameters

limit
integer
offset
integer
search
string

Request parameters

schemas
array

Response

Example request

PATCH /api/projects/:project_id/external_data_sources/:id/bulk_update_schemas
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/external_data_sources/:id/bulk_update_schemas/\
	-d schemas="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/{data_warehouse-4_id}/bulk_update_schemas/".format(
        project_id=project_id,
		data_warehouse-4_id="<the data warehouse-4 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"schemas": "array"
	}
).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"
    }
  ]
}

Create external data sources create webhook

Create, Read, Update and Delete External data Sources.

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Request parameters

client_secret
string
account_id
string
prefix
string
description
string
job_inputs

Example request

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

Example response

Status 200 No response body

Create external data sources delete webhook

Create, Read, Update and Delete External data Sources.

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Request parameters

client_secret
string
account_id
string
prefix
string
description
string
job_inputs

Example request

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

Example response

Status 200 No response body

Retrieve external data sources jobs

Create, Read, Update and Delete External data Sources.

Required API key scopes

external_data_source:read

Path parameters

id
string
project_id
string

Example request

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

Example response

Status 200 No response body

Create external data sources refresh schemas

Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync).

Required API key scopes

external_data_source:write

Path parameters

id
string
project_id
string

Request parameters

client_secret
string
account_id
string
prefix
string
description
string
job_inputs

Example request

POST /api/projects/:project_id/external_data_sources/:id/refresh_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/projects/:project_id/external_data_sources/:id/refresh_schemas/\
	-d client_secret="string",\
	-d account_id="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/{data_warehouse-4_id}/refresh_schemas/".format(
        project_id=project_id,
		data_warehouse-4_id="<the data warehouse-4 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"client_secret": "string",
		"account_id": "string"
	}
).json()