Skip to main content
Find a published note, read its text and get the numbers of its charts. Write the search words right after the command. The result is a table for people; --json prints JSON.
--limit sets the maximum number of results, up to 50. To list your own content, leave the search words empty and add --scope mine.
When has_more in the result is true, there are more results. Pass next_offset to --offset to get the next page.

Find the id

Each item in the search result has an id and a URL. Pass the id to fetch and the other commands. Use the URL to point a person to the content.

Read the text

Replace <id> with an id from the search result. The result below was run on the dashboard Sales Orders Dashboard (id pQ9rS0tU1v). Total Sales (440,826,130) is the value of the Total Sales Number chart. Long output is trimmed. Result
A note, dashboard or slide returns its text, the first rows of each embedded chart and the explanation of each analytics. The list of headings is in metadata.toc when the note is long enough to return one.

Read a long note

You do not have to read a long note in full. To read one heading, pass a heading id from metadata.toc to --section.
Replace s2 with a heading id from metadata.toc. If metadata.toc is not returned, add --include-toc to the command, or search with --query first and use a heading id shown in the result. To find a topic, pass words to --query. It returns the paragraphs that contain any of the space-separated words, each with its heading path.
When a long note is cut off, pass the value of metadata.range.next_cursor to --cursor to read on.

Get the numbers of a chart

The names of the charts in a note or dashboard are in metadata.charts in the result of fetch. Pass a name to --chart to get the numbers of that chart.
Replace <id> with the id of the note and <chart> with the chart name. The result below is for the chart qR0sT1uV (Monthly Sales Trend) in the dashboard with the id pQ9rS0tU1v. Long output is trimmed. Result
The result explains the numbers (aggregation, filters, parameter values and the data date). Pass this on when you report the numbers. To see the shape of a chart, get its image. The image is the one saved at publish time and can be older than the data. Read exact numbers with chart get-data, not from the image.
To get the result of an analytics, pass its name from metadata.blocks in the result of fetch to --analytics.