endpoints

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

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

Request

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

idstring uuid required

Unique endpoint identifier (UUID).

namestring required

URL-safe endpoint name, unique per team.

descriptionstring nullable required

Human-readable description of the endpoint.

queryunknown required
is_activeboolean required

Whether the endpoint can be executed via the API.

data_freshness_secondsinteger required

How fresh the data is, in seconds. One of: 900, 1800, 3600, 21600, 43200, 86400, 604800.

endpoint_pathstring required

Relative API path to execute this endpoint (e.g. /api/projects/{team_id}/endpoints/{name}/run).

urlstring nullable required

Absolute URL to execute this endpoint.

ui_urlstring nullable required

Absolute URL to view this endpoint in the PostHog UI.

created_atstring date-time required

When the endpoint was created (ISO 8601).

updated_atstring date-time required

When the endpoint was last updated (ISO 8601).

is_materializedboolean required

Whether the current version's results are pre-computed to S3.

current_versioninteger required

Latest version number.

current_version_idstring uuid nullable

UUID of the current EndpointVersion row.

versions_countinteger required

Total number of versions for this endpoint.

derived_from_insightstring nullable required

Short ID of the source insight, if derived from one.

last_executed_atstring date-time nullable required

When this specific version was last executed via the API (ISO 8601), or null if it hasn't been executed. Per-version tracking is recent, so versions that predate it read null until their next run.

bucket_overridesobject nullable required

Per-column bucket overrides for range variable materialization.

tagsstring[] required

Tag names associated with this endpoint.

optional_breakdown_propertiesstring[] required

Breakdown property names that may be omitted on /run. Omitted ones return data aggregated across all values of that breakdown.

versioninteger required

Version number.

version_idstring uuid required

Version unique identifier (UUID).

endpoint_is_activeboolean required

Whether the parent endpoint is active (distinct from version.is_active).

version_created_atstring required

ISO 8601 timestamp when this version was created.

version_updated_atstring nullable required

ISO 8601 timestamp when this version was last updated.

Changes