provider notebooks POST /api/projects/{project_id}/notebooks/{short_id}/hogql/execute/
@utdk/posthog /api/projects/{project_id}/notebooks/{short_id}/hogql/execute/
notebooks_hogql_execute_create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string
short_id path required
string

Try it

Authentication
Configure credentials for PostHog API
notebooksHogqlExecuteCreate
POST/api/projects/{project_id}/notebooks/{short_id}/hogql/execute/
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.

Parameters

required

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

required

Input

required

UUID of the notebook.

required

Short alphanumeric identifier used in URLs and API lookups.

Title of the notebook.

Notebook content as a ProseMirror JSON document structure.

Plain text representation of the notebook content for search.

Version number for optimistic concurrency control. Must match the current version when updating content.

Whether the notebook has been soft-deleted.

required
required
required
required
required

The effective access level the user has for this object

required

Parent resource this notebook is attached to, or `null`. Returns `{type: 'account', id: <uuid>}` for account-linked notebooks; used by the frontend to route breadcrumbs back to the resource's list.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.notebooksHogqlExecuteCreate()