Data
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
PATCH | |
DELETE | |
POST | |
DELETE | |
POST | |
POST | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
PATCH | |
POST | |
POST | |
GET | |
POST | |
POST | |
PATCH |
Update environments external data schemas
Also available via the PostHog MCP server:
external-data-schemas-partial-update— Update data import schema
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- should_syncboolean
- sync_type
- incremental_fieldstringnull
- incremental_field_type
- sync_frequency
- sync_time_of_daystringnull
- primary_key_columnsarraynull
- cdc_table_mode
- enabled_columnsarraynull
Response
Example request
PATCH /api /environments /:environment_id /external_data_schemas /:idExample response
Status 200
Delete environments external data schemas
Required API key scopes
external_data_source:writePath parameters
- idstring
Example request
DELETE /api /environments /:environment_id /external_data_schemas /:idExample response
Status 204 No response body
Create environments external data schemas cancel
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- should_syncboolean
- sync_type
- incremental_fieldstringnull
- incremental_field_type
- sync_frequency
- sync_time_of_daystringnull
- primary_key_columnsarraynull
- cdc_table_mode
- enabled_columnsarraynull
Example request
POST /api /environments /:environment_id /external_data_schemas /:id /cancelExample response
Status 200 No response body
Delete environments external data schemas delete data
Required API key scopes
external_data_source:writePath parameters
- idstring
Example request
DELETE /api /environments /:environment_id /external_data_schemas /:id /delete_dataExample response
Status 204 No response body
Create environments external data schemas incremental fields
Also available via the PostHog MCP server:
external-data-schemas-incremental-fields-create— Refresh candidate incremental fields for a schema
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- should_syncboolean
- sync_type
- incremental_fieldstringnull
- incremental_field_type
- sync_frequency
- sync_time_of_daystringnull
- primary_key_columnsarraynull
- cdc_table_mode
- enabled_columnsarraynull
Example request
POST /api /environments /:environment_id /external_data_schemas /:id /incremental_fieldsExample response
Status 200 No response body
Create environments external data schemas reload
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- should_syncboolean
- sync_type
- incremental_fieldstringnull
- incremental_field_type
- sync_frequency
- sync_time_of_daystringnull
- primary_key_columnsarraynull
- cdc_table_mode
- enabled_columnsarraynull
Example request
POST /api /environments /:environment_id /external_data_schemas /:id /reloadExample response
Status 200 No response body
Create environments external data schemas resync
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- should_syncboolean
- sync_type
- incremental_fieldstringnull
- incremental_field_type
- sync_frequency
- sync_time_of_daystringnull
- primary_key_columnsarraynull
- cdc_table_mode
- enabled_columnsarraynull
Example request
POST /api /environments /:environment_id /external_data_schemas /:id /resyncExample response
Status 200 No response body
List all environments external data sources
Also available via the PostHog MCP server:
external-data-sources-list— List data warehouse sources
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:readQuery parameters
- limitinteger
- offsetinteger
- searchstring
Response
Example request
GET /api /environments /:environment_id /external_data_sourcesExample response
Status 200
Create environments external data sources
Also available via the PostHog MCP server:
external-data-sources-create— Create data warehouse source
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writeRequest parameters
- source_type
- payloadobject
- prefixstringnull
- descriptionstringnull
- access_methodDefault:
warehouse - created_viaDefault:
api
Response
Example request
POST /api /environments /:environment_id /external_data_sourcesExample response
Status 201
Retrieve environments external data sources
Also available via the PostHog MCP server:
external-data-sources-retrieve— Get data warehouse source
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:readPath parameters
- idstring
Response
Example request
GET /api /environments /:environment_id /external_data_sources /:idExample response
Status 200
Update environments external data sources
Also available via the PostHog MCP server:
external-data-sources-partial-update— Update data warehouse source
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- created_via
- client_secretstring
- account_idstring
- prefixstringnull
- descriptionstringnull
- job_inputs
Response
Example request
PATCH /api /environments /:environment_id /external_data_sources /:idExample response
Status 200
Delete environments external data sources
Also available via the PostHog MCP server:
external-data-sources-destroy— Delete data warehouse source
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writePath parameters
- idstring
Example request
DELETE /api /environments /:environment_id /external_data_sources /:idExample response
Status 204 No response body
Update environments external data sources bulk update schemas
Create, Read, Update and Delete External data Sources.
Path parameters
- idstring
Query parameters
- limitinteger
- offsetinteger
- searchstring
Request parameters
- schemasarray
Response
Example request
PATCH /api /environments /:environment_id /external_data_sources /:id /bulk_update_schemasExample response
Status 200
Create environments external data sources create webhook
Also available via the PostHog MCP server:
external-data-sources-create-webhook-create— Create and register a webhook for a source
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- created_via
- client_secretstring
- account_idstring
- prefixstringnull
- descriptionstringnull
- job_inputs
Example request
POST /api /environments /:environment_id /external_data_sources /:id /create_webhookExample response
Status 200 No response body
Create environments external data sources delete webhook
Also available via the PostHog MCP server:
external-data-sources-delete-webhook-create— Delete a source's webhook
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- created_via
- client_secretstring
- account_idstring
- prefixstringnull
- descriptionstringnull
- job_inputs
Example request
POST /api /environments /:environment_id /external_data_sources /:id /delete_webhookExample response
Status 200 No response body
Retrieve environments external data sources jobs
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:readPath parameters
- idstring
Example request
GET /api /environments /:environment_id /external_data_sources /:id /jobsExample response
Status 200 No response body
Create environments 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:writePath parameters
- idstring
Request parameters
- created_via
- client_secretstring
- account_idstring
- prefixstringnull
- descriptionstringnull
- job_inputs
Example request
POST /api /environments /:environment_id /external_data_sources /:id /refresh_schemasExample response
Status 200 No response body
Create environments external data sources reload
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- created_via
- client_secretstring
- account_idstring
- prefixstringnull
- descriptionstringnull
- job_inputs
Example request
POST /api /environments /:environment_id /external_data_sources /:id /reloadExample response
Status 200 No response body
Update environments external data sources revenue analytics config
Update the revenue analytics configuration and return the full external data source.
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- created_via
- client_secretstring
- account_idstring
- prefixstringnull
- descriptionstringnull
- job_inputs
Example request
PATCH /api /environments /:environment_id /external_data_sources /:id /revenue_analytics_config