DAdatadog
Notebooks

Get all notebooks

Get all notebooks. This can also be used to search for notebooks with a particular query in the notebook name or author handle.

get/api/v1/notebooks

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v1/notebooks
  • Auth
    API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY

Query parameters

author_handlestring
Example:test@datadoghq.com

Return notebooks created by the given author_handle.

exclude_author_handlestring
Example:test@datadoghq.com

Return notebooks not created by the given author_handle.

startinteger

The index of the first notebook you want returned.

countinteger
Example:5

The number of notebooks to be returned.

sort_fieldstring
Example:modified

Sort by field modified, name, or created.

sort_dirstring
Example:desc

Sort by direction asc or desc.

querystring
Example:postmortem

Return only notebooks with query string in notebook name or author handle.

include_cellsboolean

Value of false excludes the cells and global time for each notebook.

is_templateboolean

True value returns only template notebooks. Default is false (returns only non-template notebooks).

typestring
Example:investigation

If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.

Response

OK

Changes

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