--- title: "Get all notebooks" method: GET path: "/api/v1/notebooks" tags: ["Notebooks"] --- # Get all notebooks `GET /api/v1/notebooks` Get all notebooks. This can also be used to search for notebooks with a particular `query` in the notebook `name` or author `handle`. ## Query parameters - `author_handle` string - `exclude_author_handle` string - `start` integer - `count` integer - `sort_field` string - `sort_dir` string - `query` string - `include_cells` boolean - `is_template` boolean - `type` string ## Response `200` OK - NotebooksResponse — Notebooks get all response. - `data` NotebooksResponseData[] — List of notebook definitions. - `attributes` NotebooksResponseDataAttributes, required — The attributes of a notebook in get all response. - `author` NotebookAuthor — Attributes of user object returned by the API. - `created_at` string, date-time — Creation time of the user. - `disabled` boolean — Whether the user is disabled. - `email` string — Email of the user. - `handle` string — Handle of the user. - `icon` string — URL of the user's icon. - `name` string, nullable — Name of the user. - `status` string — Status of the user. - `title` string, nullable — Title of the user. - `verified` boolean — Whether the user is verified. - `cells` NotebookCellResponse[] — List of cells to display in the notebook. - `attributes` union, required — The attributes of a notebook cell response. Valid cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/) - NotebookMarkdownCellAttributes — The attributes of a notebook `markdown` cell. - `definition` NotebookMarkdownCellDefinition, required — Text in a notebook is formatted with [Markdown](https://daringfireball.net/projects/markdown/), which enables the use of headings, subheadings, links, images, lists, and code blocks. - … - NotebookTimeseriesCellAttributes — The attributes of a notebook `timeseries` cell. - `definition` TimeseriesWidgetDefinition, required — The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. - … - `graph_size` 'xs' | 's' | 'm' | 'l' | 'xl' — The size of the graph. - `split_by` NotebookSplitBy — Object describing how to split the graph to display multiple visualizations per request. - … - `time` union — Timeframe for the notebook cell. When 'null', the notebook global time is used. - … - NotebookToplistCellAttributes — The attributes of a notebook `toplist` cell. - `definition` ToplistWidgetDefinition, required — The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. - … - `graph_size` 'xs' | 's' | 'm' | 'l' | 'xl' — The size of the graph. - `split_by` NotebookSplitBy — Object describing how to split the graph to display multiple visualizations per request. - … - `time` union — Timeframe for the notebook cell. When 'null', the notebook global time is used. - … - NotebookHeatMapCellAttributes — The attributes of a notebook `heatmap` cell. - `definition` HeatMapWidgetDefinition, required — The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is. - … - `graph_size` 'xs' | 's' | 'm' | 'l' | 'xl' — The size of the graph. - `split_by` NotebookSplitBy — Object describing how to split the graph to display multiple visualizations per request. - … - `time` union — Timeframe for the notebook cell. When 'null', the notebook global time is used. - … - NotebookDistributionCellAttributes — The attributes of a notebook `distribution` cell. - `definition` DistributionWidgetDefinition, required — The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time. - … - `graph_size` 'xs' | 's' | 'm' | 'l' | 'xl' — The size of the graph. - `split_by` NotebookSplitBy — Object describing how to split the graph to display multiple visualizations per request. - … - `time` union — Timeframe for the notebook cell. When 'null', the notebook global time is used. - … - NotebookLogStreamCellAttributes — The attributes of a notebook `log_stream` cell. - `definition` LogStreamWidgetDefinition, required — The Log Stream displays a log flow matching the defined query. - … - `graph_size` 'xs' | 's' | 'm' | 'l' | 'xl' — The size of the graph. - `time` union — Timeframe for the notebook cell. When 'null', the notebook global time is used. - … - `id` string, required — Notebook cell ID. - `type` 'notebook_cells', required — Type of the Notebook Cell resource. - `created` string, date-time — UTC time stamp for when the notebook was created. - `metadata` NotebookMetadata — Metadata associated with the notebook. - `is_template` boolean — Whether or not the notebook is a template. - `take_snapshots` boolean — Whether or not the notebook takes snapshot image backups of the notebook's fixed-time graphs. - `type` 'postmortem' | 'runbook' | 'investigation' | 'documentation' | 'report', nullable — Metadata type of the notebook. - `modified` string, date-time — UTC time stamp for when the notebook was last modified. - `name` string, required — The name of the notebook. - `status` 'published' — Publication status of the notebook. For now, always "published". - `template_variables` NotebookTemplateVariable[], nullable — List of template variables for this notebook. - `available_values` string[], nullable — The list of values that the template variable drop-down is limited to. - `available_values_query` union — Query used to dynamically populate the list of available values for the template variable. - NotebookTemplateVariableAvailableValuesQueryLogRumSpans — Available values query for logs, RUM, or spans data sources. - `data_source` string, required — The data source for the query. Must be one of `logs`, `rum`, or `spans`. - `group_by` NotebookTemplateVariableAvailableValuesQueryGroupBy[], required — Group-by fields for the query. - … - `search` NotebookTemplateVariableAvailableValuesQuerySearch, required — Search parameters for an available values query. - … - NotebookTemplateVariableAvailableValuesQueryMetrics — Available values query for the metrics data source. - `data_source` string, required — The data source for the query. Must be `metrics`. - `query` string, required — The metrics query string. - `data_source_mappings` object — Mapping of data source names to template variable values. - `default` string, nullable — (deprecated) The default value for the template variable on notebook load. Cannot be used in conjunction with `defaults`. - `defaults` string[] — One or many default values for the template variable. Cannot be used in conjunction with `default`. - `name` string, required — The name of the variable. - `placement` string — The placement of the template variable in the notebook. - `prefix` string, nullable — The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. - `type` string — The type of the template variable. - `time` union — Notebook global timeframe. - NotebookRelativeTime, nullable — Relative timeframe. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert', required — The available timeframes depend on the widget you are using. - NotebookAbsoluteTime — Absolute timeframe. - `end` string, date-time, required — The end time. - `live` boolean — Indicates whether the timeframe should be shifted to end at the current time. - `start` string, date-time, required — The start time. - `id` integer, required — Unique notebook ID, assigned when you create the notebook. - `type` 'notebooks', required — Type of the Notebook resource. - `meta` NotebooksResponseMeta — Searches metadata returned by the API. - `page` NotebooksResponsePage — Pagination metadata returned by the API. - `total_count` integer — The total number of notebooks that would be returned if the request was not filtered by `start` and `count` parameters. - `total_filtered_count` integer — The total number of notebooks returned. ## Other responses - `400` — Bad Request - `403` — Authentication Error - `429` — Too many requests --- [API](https://skmtc.net/datadog/apis/api-v1.md) · [All operations](https://skmtc.net/datadog/apis/api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datadog/api-v1/versions/ca5871004d26/schema)