Endpoints-3 API Reference

Endpoints-3

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

Endpoints

`GET`
`POST`
`GET`
`POST`

Retrieve endpoints run

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

Required API key scopes

endpoint:read

Path parameters

name
string
project_id
string

Example request

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

Example response

Status 200 No response body

Retrieve endpoints run

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

Required API key scopes

endpoint:read

Path parameters

name
string
project_id
string

Example request

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

Example response

Status 200 No response body

Create endpoints run

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

Required API key scopes

endpoint:read

Path parameters

name
string
project_id
string

Request parameters

client_query_id
string
debug
boolean
Default: false
filters_override
limit
integer
offset
integer
refresh
Default: cache
variables
object
version
integer

Example request

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

Example response

Status 200 No response body

Create endpoints run

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

Required API key scopes

endpoint:read

Path parameters

name
string
project_id
string

Request parameters

client_query_id
string
debug
boolean
Default: false
filters_override
limit
integer
offset
integer
refresh
Default: cache
variables
object
version
integer

Example request

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

Example response

Status 200 No response body

Retrieve endpoints versions

List all versions for an endpoint.

Required API key scopes

endpoint:read

Path parameters

name
string
project_id
string

Example request

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

Example response

Status 200 No response body

Retrieve endpoints versions

List all versions for an endpoint.

Required API key scopes

endpoint:read

Path parameters

name
string
project_id
string

Example request

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

Example response

Status 200 No response body

Create endpoints last execution times

Get the last execution times in the past 6 months for multiple endpoints.

Path parameters

project_id
string

Request parameters

names
array

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "query_status": {
    "complete": false,
    "dashboard_id": null,
    "end_time": null,
    "error": false,
    "error_message": null,
    "expiration_time": null,
    "id": "string",
    "insight_id": null,
    "labels": null,
    "pickup_time": null,
    "query_async": true,
    "query_progress": {
      "active_cpu_time": 0,
      "bytes_read": 0,
      "estimated_rows_total": 0,
      "rows_read": 0,
      "time_elapsed": 0
    },
    "results": null,
    "start_time": null,
    "task_id": null,
    "team_id": 0
  }
}

Create endpoints last execution times

Get the last execution times in the past 6 months for multiple endpoints.

Path parameters

project_id
string

Request parameters

names
array

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "query_status": {
    "complete": false,
    "dashboard_id": null,
    "end_time": null,
    "error": false,
    "error_message": null,
    "expiration_time": null,
    "id": "string",
    "insight_id": null,
    "labels": null,
    "pickup_time": null,
    "query_async": true,
    "query_progress": {
      "active_cpu_time": 0,
      "bytes_read": 0,
      "estimated_rows_total": 0,
      "rows_read": 0,
      "time_elapsed": 0
    },
    "results": null,
    "start_time": null,
    "task_id": null,
    "team_id": 0
  }
}

Endpoints-3

Endpoints

Retrieve endpoints run

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve endpoints run

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Create endpoints run

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create endpoints run

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve endpoints versions

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve endpoints versions

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Create endpoints last execution times

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Create endpoints last execution times

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Community questions