Endpoints-2

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

Endpoints

GET
GET
GET
POST
GET
POST
← Previous page

Retrieve endpoints materialization status

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

Required API key scopes

endpoint:read

Path parameters

  • name
    string

Response


Example request

GET /api/projects/:project_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/projects/:project_id/endpoints/:name/materialization_status/

Example response

Status 200
RESPONSE
{
  "name": "string",
  "status": "string",
  "can_materialize": true,
  "reason": "string",
  "last_materialized_at": "string",
  "error": "string",
  "saved_query_id": "841a020c-dad2-4bac-a071-aaf3f5af0641"
}

Retrieve endpoints openapi spec

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

Required API key scopes

endpoint:read

Path parameters

  • name
    string

Query parameters

  • version
    integer

Example request

GET /api/projects/:project_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/projects/:project_id/endpoints/:name/openapi.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

Response


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/

Example response

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

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

Request parameters

  • client_query_id
  • debug
    Default: false
  • filters_override
  • limit
  • offset
  • refresh
    Default: cache
  • variables
  • version

Response


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=undefined

Example response

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

List all endpoints versions

List all versions for an endpoint.

Required API key scopes

endpoint:read

Path parameters

  • name
    string

Query parameters

  • created_by
    integer
  • is_active
    boolean
  • limit
    integer
  • offset
    integer

Response


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/

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,
      "data_freshness_seconds": 0,
      "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": {},
        "role_at_organization": "engineering"
      },
      "is_materialized": true,
      "current_version": 0,
      "current_version_id": "158beffb-f9de-457f-bbee-873740e72504",
      "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",
        "saved_query_id": "841a020c-dad2-4bac-a071-aaf3f5af0641"
      },
      "bucket_overrides": {},
      "columns": [
        {
          "name": "string",
          "type": "string"
        }
      ],
      "tags": [
        "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": {},
        "role_at_organization": "engineering"
      }
    }
  ]
}

Create endpoints last execution times

Get the most recent execution time per endpoint (endpoint-level). Timestamps are recorded by the run path for personal-API-key calls. For per-version usage, query the query_log table directly.

Required API key scopes

endpoint:read

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"

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": null,
    "results": null,
    "start_time": null,
    "task_id": null,
    "team_id": 0
  }
}
← Previous page

Community questions

Questions about this page? or post a community question.