endpoints

Preview the materialization transform for an endpoint. Shows what the query will look like after materialization, including range pair detection and bucket functions.

post/api/projects/{project_id}/endpoints/{name}/materialization_preview/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/endpoints/{name}/materialization_preview/
  • 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/.

Request body

versioninteger

Endpoint version to preview. Defaults to the current version.

bucket_overridesobject nullable

Per-column bucket function overrides, e.g. {"timestamp": "hour"}

Response

can_materializeboolean required

Whether the endpoint query can be materialized.

reasonstring nullable required

Why the query cannot be materialized, or null when it can.

transformed_querystring nullable required

Query rewritten for materialization, when one could be produced.

execution_querystring nullable required

Query that would run against the materialized table.

display_execution_querystring nullable required

Execution query formatted for display.

Changes

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