notebooks

The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.

get/api/projects/{project_id}/notebooks/

Request

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

containsstring

Filter for notebooks that match a provided filter. Each match pair is separated by a colon, multiple match pairs can be sent separated by a space or a comma

created_bystring uuid

The UUID of the Notebook's creator

date_fromstring date-time

Filter for notebooks created after this date & time

date_tostring date-time

Filter for notebooks created before this date & time

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

userstring

If any value is provided for this parameter, return notebooks created by the logged in user.

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.