External Data API Reference

External Data

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

Endpoints

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

List all external data sources list

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",
      "last_run_at": "string",
      "schemas": "string",
      "job_inputs": null,
      "revenue_analytics_config": {
        "enabled": true,
        "include_invoiceless_charges": true
      },
      "user_access_level": "string"
    }
  ]
}

Create external data sources create

Create, Read, Update and Delete External data Sources.

Required API key scopes

external_data_source:write

Path parameters

project_id
string

Request parameters

client_secret
string
account_id
string
description
string
job_inputs

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 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/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"client_secret": "string",
		"account_id": "string"
	}
).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",
  "last_run_at": "string",
  "schemas": "string",
  "job_inputs": null,
  "revenue_analytics_config": {
    "enabled": true,
    "include_invoiceless_charges": true
  },
  "user_access_level": "string"
}

Retrieve external data sources retrieve

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/{external_data_source_id}/".format(
        project_id=project_id,
		external_data_source_id="<the external data source 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",
  "last_run_at": "string",
  "schemas": "string",
  "job_inputs": null,
  "revenue_analytics_config": {
    "enabled": true,
    "include_invoiceless_charges": true
  },
  "user_access_level": "string"
}

Update external data sources update

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
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/{external_data_source_id}/".format(
        project_id=project_id,
		external_data_source_id="<the external data source 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",
  "last_run_at": "string",
  "schemas": "string",
  "job_inputs": null,
  "revenue_analytics_config": {
    "enabled": true,
    "include_invoiceless_charges": true
  },
  "user_access_level": "string"
}

Delete external data sources destroy

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/{external_data_source_id}/".format(
        project_id=project_id,
		external_data_source_id="<the external data source id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Retrieve external data sources jobs retrieve

Create, Read, Update and Delete External data Sources.

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/{external_data_source_id}/jobs/".format(
        project_id=project_id,
		external_data_source_id="<the external data source id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create external data sources reload create

Create, Read, Update and Delete External data Sources.

Path parameters

id
string
project_id
string

Request parameters

client_secret
string
account_id
string
description
string
job_inputs

Example request

POST /api/projects/:project_id/external_data_sources/: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_sources/:id/reload/\
	-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/{external_data_source_id}/reload/".format(
        project_id=project_id,
		external_data_source_id="<the external data source id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"client_secret": "string",
		"account_id": "string"
	}
).json()

Example response

Status 200 No response body

Update external data sources revenue analytics config update

Update the revenue analytics configuration and return the full external data source.

Path parameters

id
string
project_id
string

Request parameters

client_secret
string
account_id
string
description
string
job_inputs

Example request

PATCH /api/projects/:project_id/external_data_sources/:id/revenue_analytics_config
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/revenue_analytics_config/\
	-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/{external_data_source_id}/revenue_analytics_config/".format(
        project_id=project_id,
		external_data_source_id="<the external data source id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"created_at": "string"
	}
).json()

Example response

Status 200 No response body

Create external data sources database schema create

Create, Read, Update and Delete External data Sources.

Path parameters

project_id
string

Request parameters

client_secret
string
account_id
string
description
string
job_inputs

Example request

POST /api/projects/:project_id/external_data_sources/database_schema
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/database_schema/\
	-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/database_schema/".format(
        project_id=project_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 source prefix create

Create, Read, Update and Delete External data Sources.

Path parameters

project_id
string

Request parameters

client_secret
string
account_id
string
description
string
job_inputs

Example request

POST /api/projects/:project_id/external_data_sources/source_prefix
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/source_prefix/\
	-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/source_prefix/".format(
        project_id=project_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 wizard retrieve

Create, Read, Update and Delete External data Sources.

Path parameters

project_id
string

Example request

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

External Data

Endpoints

List all external data sources list

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create external data sources create

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve external data sources retrieve

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update external data sources update

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete external data sources destroy

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Retrieve external data sources jobs retrieve

Path parameters

Example request

Example response

Status 200 No response body

Create external data sources reload create

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Update external data sources revenue analytics config update

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create external data sources database schema create

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create external data sources source prefix create

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve external data sources wizard retrieve

Path parameters

Example request

Example response

Status 200 No response body

Community questions