Skip to main content
GET
/
projects
/
{projectName}
/
packages
/
{packageName}
/
notebooks
/
{path}
Get Malloy notebook cells
curl --request GET \
  --url https://{organization}.data.credibledata.com/api/v0/projects/{projectName}/packages/{packageName}/notebooks/{path} \
  --header 'Authorization: Bearer <token>'
{
  "resource": "<string>",
  "packageName": "<string>",
  "path": "<string>",
  "malloyVersion": "<string>",
  "notebookCells": [
    {
      "type": "markdown",
      "text": "<string>",
      "newSources": [
        "<string>"
      ],
      "queryInfo": "<string>"
    }
  ],
  "annotations": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
projectName
string
required

Name of the project Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$
​
packageName
string
required

Name of the package

​
path
string
required

Path to notebook within the package.

Query Parameters

​
versionId
string

Version identifier for the package Version identifier pattern supporting dots and dashes

Pattern: ^[a-zA-Z0-9_.-]+$

Response

A Malloy notebook with raw cell contents.

Raw Malloy notebook with unexecuted cell contents

​
resource
string

Resource path to the notebook

​
packageName
string

Name of the package containing this notebook

​
path
string

Relative path to the notebook file within its package directory

​
malloyVersion
string

Version of the Malloy compiler used to generate the notebook data

​
notebookCells
object[]

Array of notebook cells containing raw markdown and code content

​
annotations
string[]

Array of file-level (##) annotations attached to the notebook