Environments-12 API Reference

Environments-12

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

Endpoints

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

Retrieve exports content

Required API key scopes

export:read

Path parameters

id
integer
project_id
string

Example request

GET /api/environments/:project_id/exports/:id/content
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/exports/:id/content/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/exports/{environments-12_id}/content/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).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/environments/: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/environments/:project_id/external_data_sources/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{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, 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/environments/: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/environments/: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/environments/{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

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/environments/: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/environments/:project_id/external_data_sources/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/external_data_sources/{environments-12_id}/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 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

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/environments/: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/environments/: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/environments/{project_id}/external_data_sources/{environments-12_id}/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 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

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

Example response

Status 204 No response body

Retrieve external data sources jobs

Create, Read, Update and Delete External data Sources.

Path parameters

id
string
project_id
string

Example request

GET /api/environments/: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/environments/: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/environments/{project_id}/external_data_sources/{environments-12_id}/jobs/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create external data sources reload

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/environments/: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/environments/: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/environments/{project_id}/external_data_sources/{environments-12_id}/reload/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 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 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/environments/: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/environments/: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/environments/{project_id}/external_data_sources/{environments-12_id}/revenue_analytics_config/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 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, 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/environments/: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/environments/: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/environments/{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, 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/environments/: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/environments/: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/environments/{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

Create, Read, Update and Delete External data Sources.

Path parameters

project_id
string

Example request

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

Example response

Status 200 No response body

List all file system

Required API key scopes

file_system:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer
search
string

Response

Example request

GET /api/environments/:project_id/file_system
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/file_system/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/file_system/".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",
      "path": "string",
      "depth": 0,
      "type": "string",
      "ref": "string",
      "href": "string",
      "meta": null,
      "shortcut": true,
      "created_at": "2019-08-24T14:15:22Z",
      "last_viewed_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create file system

Required API key scopes

file_system:write

Path parameters

project_id
string

Request parameters

path
string
type
string
ref
string
href
string
meta
shortcut
boolean

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "depth": 0,
  "type": "string",
  "ref": "string",
  "href": "string",
  "meta": null,
  "shortcut": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z"
}

Retrieve file system

Required API key scopes

file_system:read

Path parameters

id
string
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "depth": 0,
  "type": "string",
  "ref": "string",
  "href": "string",
  "meta": null,
  "shortcut": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z"
}

Update file system

Required API key scopes

file_system:write

Path parameters

id
string
project_id
string

Request parameters

path
string
type
string
ref
string
href
string
meta
shortcut
boolean

Response

Example request

PATCH /api/environments/:project_id/file_system/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/file_system/:id/\
	-d path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/file_system/{environments-12_id}/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "depth": 0,
  "type": "string",
  "ref": "string",
  "href": "string",
  "meta": null,
  "shortcut": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z"
}

Delete file system

Required API key scopes

file_system:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/environments/:project_id/file_system/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/file_system/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{project_id}/file_system/{environments-12_id}/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Create file system count

Get count of all files in a folder.

Path parameters

id
string
project_id
string

Request parameters

path
string
type
string
ref
string
href
string
meta
shortcut
boolean

Example request

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