Endpoints-2

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

Endpoints

POST
GET
POST
GET
POST
GET
PATCH
DELETE
POST

Create 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

Request parameters

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

Response


Example request

POST /api/environments/:environment_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/environments/:environment_id/endpoints/:name/run/\
	-d client_query_id="string"

Example response

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

Create 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

Request parameters

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

Response


Example request

POST /api/environments/:environment_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/environments/:environment_id/endpoints/:name/run/\
	-d client_query_id="string"

Example response

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

List all environments endpoints versions

List all versions for an endpoint.

Required API key scopes

endpoint:read

Path parameters

  • environment_id
    string
  • name
    string

Query parameters

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

Response


Example request

GET /api/environments/:environment_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/environments/:environment_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,
      "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"
      }
    }
  ]
}

List all environments endpoints versions

List all versions for an endpoint.

Required API key scopes

endpoint:read

Path parameters

  • environment_id
    string
  • name
    string

Query parameters

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

Response


Example request

GET /api/environments/:environment_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/environments/:environment_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,
      "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"
      }
    }
  ]
}

Create environments endpoints last execution times

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

Path parameters

  • environment_id
    string

Request parameters

  • names
    array

Response


Example request

POST /api/environments/:environment_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/environments/:environment_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": {
      "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 environments endpoints last execution times

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

Path parameters

  • environment_id
    string

Request parameters

  • names
    array

Response


Example request

POST /api/environments/:environment_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/environments/:environment_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": {
      "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
  }
}

List all endpoints

List all endpoints for the team.

Required API key scopes

endpoint:read

Path parameters

  • project_id
    string

Query parameters

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

Response


Example request

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

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 endpoints

List all endpoints for the team.

Required API key scopes

endpoint:read

Path parameters

  • project_id
    string

Query parameters

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

Response


Example request

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

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 endpoints

Create a new endpoint.

Required API key scopes

endpoint:write

Path parameters

  • project_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/projects/:project_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/projects/:project_id/endpoints/\
	-d name="string"

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 endpoints

Create a new endpoint.

Required API key scopes

endpoint:write

Path parameters

  • project_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/projects/:project_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/projects/:project_id/endpoints/\
	-d name="string"

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 endpoints

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

Required API key scopes

endpoint:read

Path parameters

  • name
    string
  • project_id
    string

Response


Example request

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

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 endpoints

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

Required API key scopes

endpoint:read

Path parameters

  • name
    string
  • project_id
    string

Response


Example request

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

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 endpoints

Update an existing endpoint.

Required API key scopes

endpoint:write

Path parameters

  • name
    string
  • project_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

PATCH /api/projects/:project_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/projects/:project_id/endpoints/:name/\
	-d name="string"

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 endpoints

Update an existing endpoint.

Required API key scopes

endpoint:write

Path parameters

  • name
    string
  • project_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

PATCH /api/projects/:project_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/projects/:project_id/endpoints/:name/\
	-d name="string"

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 endpoints

Delete an endpoint and clean up materialized query.

Required API key scopes

endpoint:write

Path parameters

  • name
    string
  • project_id
    string

Example request

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

Example response

Status 204 No response body

Delete endpoints

Delete an endpoint and clean up materialized query.

Required API key scopes

endpoint:write

Path parameters

  • name
    string
  • project_id
    string

Example request

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

Example response

Status 204 No response body

Create 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

  • name
    string
  • project_id
    string

Request parameters

  • version
    integer
  • bucket_overrides
    object

Example request

POST /api/projects/:project_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/projects/:project_id/endpoints/:name/materialization_preview/\
	-d version="integer"

Example response

Status 200 No response body

Create 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

  • name
    string
  • project_id
    string

Request parameters

  • version
    integer
  • bucket_overrides
    object

Example request

POST /api/projects/:project_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/projects/:project_id/endpoints/:name/materialization_preview/\
	-d version="integer"

Example response

Status 200 No response body
Next page →

Community questions

Questions about this page? or post a community question.