Endpoints API Reference

Endpoints

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

Endpoints

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

Retrieve environments endpoints

List all endpoints for the team.

Required API key scopes

endpoint:read

Path parameters

environment_id
string

Example request

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

Example response

Status 200 No response body

Retrieve environments endpoints

List all endpoints for the team.

Required API key scopes

endpoint:read

Path parameters

environment_id
string

Example request

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

Example response

Status 200 No response body

Create environments endpoints

Create a new endpoint

Required API key scopes

endpoint:write

Path parameters

environment_id
string

Request parameters

bucket_overrides
object
cache_age_seconds
number
derived_from_insight
string
description
string
is_active
boolean
is_materialized
boolean
name
string
query
sync_frequency
version
integer

Example request

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

Example response

Status 201 No response body

Create environments endpoints

Create a new endpoint

Required API key scopes

endpoint:write

Path parameters

environment_id
string

Request parameters

bucket_overrides
object
cache_age_seconds
number
derived_from_insight
string
description
string
is_active
boolean
is_materialized
boolean
name
string
query
sync_frequency
version
integer

Example request

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

Example response

Status 201 No response body

Retrieve environments endpoints retrieve

Retrieve an endpoint, or a specific endpoint version.

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Example request

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

Example response

Status 200 No response body

Retrieve environments endpoints retrieve

Retrieve an endpoint, or a specific endpoint version.

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Example request

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

Example response

Status 200 No response body

Update environments endpoints

Required API key scopes

endpoint:write

Path parameters

environment_id
string
name
string

Example request

PATCH /api/environments/:environment_id/endpoints/:name
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/endpoints/:name/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/endpoints/{name}/".format(
        project_id=project_id,
		environment_id="<the environment id>",,
		name="<the name>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Update environments endpoints

Required API key scopes

endpoint:write

Path parameters

environment_id
string
name
string

Example request

PATCH /api/environments/:environment_id/endpoints/:name
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/endpoints/:name/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/endpoints/{name}/".format(
        project_id=project_id,
		environment_id="<the environment id>",,
		name="<the name>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Delete environments endpoints

Delete an endpoint and clean up materialized query.

Required API key scopes

endpoint:write

Path parameters

environment_id
string
name
string

Example request

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

Example response

Status 204 No response body

Delete environments endpoints

Delete an endpoint and clean up materialized query.

Required API key scopes

endpoint:write

Path parameters

environment_id
string
name
string

Example request

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

Example response

Status 204 No response body

Retrieve environments endpoints materialization preview

Preview the materialization transform for an endpoint. Shows what the query will look like after materialization, including range pair detection and bucket functions.

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Example request

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

Example response

Status 200 No response body

Retrieve environments endpoints materialization preview

Preview the materialization transform for an endpoint. Shows what the query will look like after materialization, including range pair detection and bucket functions.

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Example request

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

Example response

Status 200 No response body

Retrieve environments endpoints materialization status

Get materialization status for an endpoint. Supports ?version=N query param.

Path parameters

environment_id
string
name
string

Example request

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

Example response

Status 200 No response body

Retrieve environments endpoints materialization status

Get materialization status for an endpoint. Supports ?version=N query param.

Path parameters

environment_id
string
name
string

Example request

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

Example response

Status 200 No response body

Retrieve environments endpoints openapi.json

Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients.

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Example request

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

Example response

Status 200 No response body

Retrieve environments endpoints openapi.json

Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients.

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Example request

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

Example response

Status 200 No response body

Retrieve environments endpoints run

Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set.

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Example request

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

Example response

Status 200 No response body

Retrieve environments endpoints run

Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set.

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Example request

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