Datadog Notebooks

List notebooks

Get all notebooks.

Inputs

Field

Type

Description

start

number

The index of the first notebook you want returned.

count

number

The number of notebooks to be returned. The default is 50 notebooks.

sort_field

enum

Sort by field modified, name, or created. Allowed enum values: modified,name,created

sort_dir

enum

Sort by direction asc or desc. Allowed enum values: asc,desc

query

string

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

is_template

boolean

True value returns only template notebooks.

Outputs

Expand All

Field

Type

Description

notebooks [required]

[object]

List of notebook definitions.

id [required]

number,string

Unique notebook ID, assigned when you create the notebook.

type [required]

string

Type of the Notebook resource.

default: notebooks

cells [required]

[object]

List of cells to display in the notebook.

id [required]

string

Notebook cell ID.

type [required]

string

Type of the Notebook Cell resource.

default: notebook_cells

attributes [required]

The attributes of a notebook cell response.

time [required]

Notebook global timeframe.

url [required]

string

status

string

Publication status of the notebook.

default: published

metadata

object

Metadata associated with the notebook.

is_template

boolean

Whether or not the notebook is a template.

is_favorite

boolean

Whether or not the notebook is favorited.

take_snapshots

boolean

Whether or not the notebook takes snapshot image backups of the notebook's fixed-time graphs.

type

Metadata type of the notebook.

name [required]

string

The name of the notebook.

author

object

Attributes of user object returned by the API.

name

string,null

Name of the user.

handle

string

Handle of the user.

created_at

date-time

Creation time of the user.

email

string

Email of the user.

icon

string

URL of the user's icon.

title

string,null

Title of the user.

verified

boolean

Whether the user is verified.

disabled

boolean

Whether the user is disabled.

status

string

Status of the user.

created

date-time

UTC time stamp for when the notebook was created.

modified

date-time

UTC time stamp for when the notebook was last modified.

template_variables

meta

object

Searches metadata returned by the API.