saved_query_column_annotations

Read and edit semantic descriptions of data-modelling views and columns surfaced to the AI agent.

List can be filtered to one view with ?saved_query_id=<uuid>. Any create or update is treated as a user edit (is_user_edited=True), which protects the row from being overwritten by automatic enrichment. Create upserts on (saved_query, column_name); the view cannot be changed after creation.

get/api/projects/{project_id}/saved_query_column_annotations/

Request

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

Path parameters

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

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

saved_query_idstring uuid

Only return annotations for this data warehouse saved query (view).

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

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