Endpoints API Reference

Endpoints

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

Endpoints

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

List all environments endpoints

List all endpoints for the team.

Required API key scopes

endpoint:read

Path parameters

environment_id
string

Query parameters

created_by
integer
is_active
boolean
limit
integer
offset
integer

Response

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

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",
      "description": "string",
      "query": null,
      "is_active": true,
      "cache_age_seconds": 0.1,
      "endpoint_path": "string",
      "url": "string",
      "ui_url": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "is_materialized": true,
      "current_version": 0,
      "versions_count": 0,
      "derived_from_insight": "string",
      "last_executed_at": "2019-08-24T14:15:22Z",
      "materialization": {
        "name": "string",
        "status": "string",
        "can_materialize": true,
        "reason": "string",
        "last_materialized_at": "string",
        "error": "string",
        "sync_frequency": "string"
      },
      "bucket_overrides": {
        "property1": null,
        "property2": null
      },
      "columns": [
        {
          "name": "string",
          "type": "string"
        }
      ]
    }
  ]
}

List all environments endpoints

List all endpoints for the team.

Required API key scopes

endpoint:read

Path parameters

environment_id
string

Query parameters

created_by
integer
is_active
boolean
limit
integer
offset
integer

Response

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

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",
      "description": "string",
      "query": null,
      "is_active": true,
      "cache_age_seconds": 0.1,
      "endpoint_path": "string",
      "url": "string",
      "ui_url": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "is_materialized": true,
      "current_version": 0,
      "versions_count": 0,
      "derived_from_insight": "string",
      "last_executed_at": "2019-08-24T14:15:22Z",
      "materialization": {
        "name": "string",
        "status": "string",
        "can_materialize": true,
        "reason": "string",
        "last_materialized_at": "string",
        "error": "string",
        "sync_frequency": "string"
      },
      "bucket_overrides": {
        "property1": null,
        "property2": null
      },
      "columns": [
        {
          "name": "string",
          "type": "string"
        }
      ]
    }
  ]
}

Create environments endpoints

Create a new endpoint.

Required API key scopes

endpoint:write

Path parameters

environment_id
string

Request parameters

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

Response

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 name="string"
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={
		"name": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "query": null,
  "is_active": true,
  "cache_age_seconds": 0.1,
  "endpoint_path": "string",
  "url": "string",
  "ui_url": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "is_materialized": true,
  "current_version": 0,
  "versions_count": 0,
  "derived_from_insight": "string",
  "last_executed_at": "2019-08-24T14:15:22Z",
  "materialization": {
    "name": "string",
    "status": "string",
    "can_materialize": true,
    "reason": "string",
    "last_materialized_at": "string",
    "error": "string",
    "sync_frequency": "string"
  },
  "bucket_overrides": {
    "property1": null,
    "property2": null
  },
  "columns": [
    {
      "name": "string",
      "type": "string"
    }
  ]
}

Create environments endpoints

Create a new endpoint.

Required API key scopes

endpoint:write

Path parameters

environment_id
string

Request parameters

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

Response

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 name="string"
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={
		"name": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "query": null,
  "is_active": true,
  "cache_age_seconds": 0.1,
  "endpoint_path": "string",
  "url": "string",
  "ui_url": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "is_materialized": true,
  "current_version": 0,
  "versions_count": 0,
  "derived_from_insight": "string",
  "last_executed_at": "2019-08-24T14:15:22Z",
  "materialization": {
    "name": "string",
    "status": "string",
    "can_materialize": true,
    "reason": "string",
    "last_materialized_at": "string",
    "error": "string",
    "sync_frequency": "string"
  },
  "bucket_overrides": {
    "property1": null,
    "property2": null
  },
  "columns": [
    {
      "name": "string",
      "type": "string"
    }
  ]
}

Retrieve environments endpoints

Retrieve an endpoint, or a specific version via ?version=N.

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Response

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

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "query": null,
  "is_active": true,
  "cache_age_seconds": 0.1,
  "endpoint_path": "string",
  "url": "string",
  "ui_url": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "is_materialized": true,
  "current_version": 0,
  "versions_count": 0,
  "derived_from_insight": "string",
  "last_executed_at": "2019-08-24T14:15:22Z",
  "materialization": {
    "name": "string",
    "status": "string",
    "can_materialize": true,
    "reason": "string",
    "last_materialized_at": "string",
    "error": "string",
    "sync_frequency": "string"
  },
  "bucket_overrides": {
    "property1": null,
    "property2": null
  },
  "columns": [
    {
      "name": "string",
      "type": "string"
    }
  ],
  "version": 0,
  "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
  "endpoint_is_active": true,
  "version_created_at": "string",
  "version_updated_at": "string",
  "version_created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  }
}

Retrieve environments endpoints

Retrieve an endpoint, or a specific version via ?version=N.

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Response

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

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "query": null,
  "is_active": true,
  "cache_age_seconds": 0.1,
  "endpoint_path": "string",
  "url": "string",
  "ui_url": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "is_materialized": true,
  "current_version": 0,
  "versions_count": 0,
  "derived_from_insight": "string",
  "last_executed_at": "2019-08-24T14:15:22Z",
  "materialization": {
    "name": "string",
    "status": "string",
    "can_materialize": true,
    "reason": "string",
    "last_materialized_at": "string",
    "error": "string",
    "sync_frequency": "string"
  },
  "bucket_overrides": {
    "property1": null,
    "property2": null
  },
  "columns": [
    {
      "name": "string",
      "type": "string"
    }
  ],
  "version": 0,
  "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
  "endpoint_is_active": true,
  "version_created_at": "string",
  "version_updated_at": "string",
  "version_created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  }
}

Update environments endpoints

Update an existing endpoint.

Required API key scopes

endpoint:write

Path parameters

environment_id
string
name
string

Request parameters

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

Response

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/\
	-d name="string"
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)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "query": null,
  "is_active": true,
  "cache_age_seconds": 0.1,
  "endpoint_path": "string",
  "url": "string",
  "ui_url": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "is_materialized": true,
  "current_version": 0,
  "versions_count": 0,
  "derived_from_insight": "string",
  "last_executed_at": "2019-08-24T14:15:22Z",
  "materialization": {
    "name": "string",
    "status": "string",
    "can_materialize": true,
    "reason": "string",
    "last_materialized_at": "string",
    "error": "string",
    "sync_frequency": "string"
  },
  "bucket_overrides": {
    "property1": null,
    "property2": null
  },
  "columns": [
    {
      "name": "string",
      "type": "string"
    }
  ]
}

Update environments endpoints

Update an existing endpoint.

Required API key scopes

endpoint:write

Path parameters

environment_id
string
name
string

Request parameters

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

Response

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/\
	-d name="string"
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)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "query": null,
  "is_active": true,
  "cache_age_seconds": 0.1,
  "endpoint_path": "string",
  "url": "string",
  "ui_url": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "is_materialized": true,
  "current_version": 0,
  "versions_count": 0,
  "derived_from_insight": "string",
  "last_executed_at": "2019-08-24T14:15:22Z",
  "materialization": {
    "name": "string",
    "status": "string",
    "can_materialize": true,
    "reason": "string",
    "last_materialized_at": "string",
    "error": "string",
    "sync_frequency": "string"
  },
  "bucket_overrides": {
    "property1": null,
    "property2": null
  },
  "columns": [
    {
      "name": "string",
      "type": "string"
    }
  ]
}

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

Create 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

Request parameters

version
integer
bucket_overrides
object

Example request

POST /api/environments/:environment_id/endpoints/:name/materialization_preview
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/:name/materialization_preview/\
	-d version="integer"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<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)},
	data={
		"version": "integer"
	}
).json()

Example response

Status 200 No response body

Create 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

Request parameters

version
integer
bucket_overrides
object

Example request

POST /api/environments/:environment_id/endpoints/:name/materialization_preview
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/:name/materialization_preview/\
	-d version="integer"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<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)},
	data={
		"version": "integer"
	}
).json()

Example response

Status 200 No response body

Retrieve environments endpoints materialization status

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

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Response

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

RESPONSE
{
  "name": "string",
  "status": "string",
  "can_materialize": true,
  "reason": "string",
  "last_materialized_at": "string",
  "error": "string",
  "sync_frequency": "string"
}

Retrieve environments endpoints materialization status

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

Required API key scopes

endpoint:read

Path parameters

environment_id
string
name
string

Response

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

RESPONSE
{
  "name": "string",
  "status": "string",
  "can_materialize": true,
  "reason": "string",
  "last_materialized_at": "string",
  "error": "string",
  "sync_frequency": "string"
}

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

Response

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

RESPONSE
{
  "name": "string",
  "results": [
    null
  ],
  "columns": [
    "string"
  ],
  "hasMore": true,
  "endpoint_version": 0
}

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

Response

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

RESPONSE
{
  "name": "string",
  "results": [
    null
  ],
  "columns": [
    "string"
  ],
  "hasMore": true,
  "endpoint_version": 0
}