notebook_widgets

get/api/projects/{project_id}/notebook_widgets/{id}/

Request

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

Path parameters

idstring required
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/.

Response

idstring uuid required

Stable reusable widget identifier.

namestring required

Catalog name of the reusable widget.

descriptionstring required

Description of the reusable widget.

tagsstring[] required

Searchable widget labels.

publication_status'published' | 'deprecated' required
  • published - published
  • deprecated - deprecated
version_countinteger required

Number of immutable versions in this widget's history.

instance_countinteger required

Number of notebook placements using this widget.

created_atstring date-time required

When the widget identity was created.

published_atstring date-time required

When the widget became reusable.

updated_atstring date-time required

When the reusable widget was last changed.

Changes

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