endpoints

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

get/api/projects/{project_id}/endpoints/{name}/materialization_status/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/endpoints/{name}/materialization_status/
  • Auth: HTTP bearer

Path parameters

namestring required

URL-safe name for the endpoint

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

versioninteger

Endpoint version to act on. Defaults to the current version.

Response

namestring required

URL-safe endpoint name.

enabledboolean required

Whether materialization is enabled for this endpoint version.

readyboolean required

Whether a successful materialization is available to serve.

statusstring

Current materialization status (e.g. 'Completed', 'Running').

can_materializeboolean required

Whether this endpoint query can be materialized.

reasonstring nullable

Reason why materialization is not possible (only when can_materialize is false).

last_materialized_atstring nullable

ISO 8601 timestamp of the last successful materialization.

errorstring

Last materialization error message, if any.

saved_query_idstring uuid nullable

UUID of the underlying saved query backing this materialization. Only populated when the version is materialized.

Changes

No recorded changes to this operation across all 1 revision of this API.