Get Malloy notebook cells

curl --request GET \
  --url https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "resource": "<string>",
  "packageName": "<string>",
  "path": "<string>",
  "malloyVersion": "<string>",
  "notebookCells": [
    {
      "type": "markdown",
      "text": "<string>",
      "newSources": [
        "<string>"
      ],
      "queryInfo": "<string>"
    }
  ],
  "annotations": [
    "<string>"
  ],
  "sources": [
    {
      "name": "<string>",
      "annotations": [
        "<string>"
      ],
      "views": [
        {
          "name": "<string>",
          "annotations": [
            "<string>"
          ]
        }
      ],
      "filters": [
        {
          "name": "<string>",
          "dimension": "<string>",
          "type": "equal",
          "implicit": true,
          "required": true,
          "dimensionType": "<string>"
        }
      ],
      "givens": [
        {
          "name": "<string>",
          "type": "<string>",
          "annotations": [
            "<string>"
          ],
          "default": "<string>"
        }
      ],
      "authorize": [
        "<string>"
      ]
    }
  ]
}

{
  "message": "<string>",
  "details": "<string>"
}

{
  "message": "<string>",
  "details": "<string>"
}

{
  "message": "<string>",
  "details": "<string>"
}

{
  "message": "<string>",
  "details": "<string>"
}

GET

environments

{environmentName}

packages

{packageName}

notebooks

{path}

Get Malloy notebook cells

curl --request GET \
  --url https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks/{path}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "resource": "<string>",
  "packageName": "<string>",
  "path": "<string>",
  "malloyVersion": "<string>",
  "notebookCells": [
    {
      "type": "markdown",
      "text": "<string>",
      "newSources": [
        "<string>"
      ],
      "queryInfo": "<string>"
    }
  ],
  "annotations": [
    "<string>"
  ],
  "sources": [
    {
      "name": "<string>",
      "annotations": [
        "<string>"
      ],
      "views": [
        {
          "name": "<string>",
          "annotations": [
            "<string>"
          ]
        }
      ],
      "filters": [
        {
          "name": "<string>",
          "dimension": "<string>",
          "type": "equal",
          "implicit": true,
          "required": true,
          "dimensionType": "<string>"
        }
      ],
      "givens": [
        {
          "name": "<string>",
          "type": "<string>",
          "annotations": [
            "<string>"
          ],
          "default": "<string>"
        }
      ],
      "authorize": [
        "<string>"
      ]
    }
  ]
}

{
  "message": "<string>",
  "details": "<string>"
}

{
  "message": "<string>",
  "details": "<string>"
}

{
  "message": "<string>",
  "details": "<string>"
}

{
  "message": "<string>",
  "details": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

environmentName

string

required

Name of the environment 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

Show child attributes

annotations

string[]

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

sources

object[]

Sources defined in the notebook's model

Show child attributes

Overview

publisher

environments

connections

packages

models

notebooks

databases

pages

watch-mode

connectionsTest

materializations

Get Malloy notebook cells

Authorizations

Path Parameters

Query Parameters

Response