Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'author_handle', 'test@datadoghq.com'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'exclude_author_handle', 'test@datadoghq.com'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'start', 0
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'count', 5
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sort_field', 'modified'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sort_dir', 'desc'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'query', 'postmortem'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'include_cells', 'false'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'is_template', 'false'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'type', 'investigation'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.app.ddog-gov.com/api/v1/notebooks', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "data": [
-- {
-- "id": 123456,
-- "type": "notebooks",
-- "attributes": {
-- "name": "Example Notebook",
-- "author": {
-- "created_at": "1981-07-01T19:18:52.706Z",
-- "disabled": true,
-- "email": "enim fugiat",
-- "handle": "in",
-- "icon": "ut laborum",
-- "name": "ex sunt dolore eiusmod",
-- "status": "in nisi non velit adipisicing",
-- "title": "veniam dolor",
-- "verified": false
-- },
-- "cells": [
-- {
-- "id": "abcd1234",
-- "type": "notebook_cells",
-- "attributes": {
-- "definition": {
-- "type": "markdown",
-- "text": "# Example Header \nexample content"
-- }
-- }
-- },
-- {
-- "id": "abcd1234",
-- "type": "notebook_cells",
-- "attributes": {
-- "definition": {
-- "type": "markdown",
-- "text": "# Example Header \nexample content"
-- }
-- }
-- }
-- ],
-- "created": "2021-02-24T23:14:15.173964+00:00",
-- "metadata": {
-- "is_template": false,
-- "take_snapshots": false,
-- "type": "investigation"
-- },
-- "modified": "2021-02-24T23:15:23.274966+00:00",
-- "status": "published",
-- "time": {
-- "live_span": "1h"
-- }
-- }
-- },
-- {
-- "id": 123456,
-- "type": "notebooks",
-- "attributes": {
-- "name": "Example Notebook",
-- "author": {
-- "created_at": "1984-05-01T21:20:20.424Z",
-- "disabled": true,
-- "email": "cillum",
-- "handle": "et in Excepteur sunt aute",
-- "icon": "minim dolore sint eu deserunt",
-- "name": "ex reprehenderit labore",
-- "status": "dolor consectetur",
-- "title": "ex ut dolore",
-- "verified": true
-- },
-- "cells": [
-- {
-- "id": "abcd1234",
-- "type": "notebook_cells",
-- "attributes": {
-- "definition": {
-- "type": "markdown",
-- "text": "# Example Header \nexample content"
-- }
-- }
-- },
-- {
-- "id": "abcd1234",
-- "type": "notebook_cells",
-- "attributes": {
-- "definition": {
-- "type": "markdown",
-- "text": "# Example Header \nexample content"
-- }
-- }
-- }
-- ],
-- "created": "2021-02-24T23:14:15.173964+00:00",
-- "metadata": {
-- "is_template": false,
-- "take_snapshots": false,
-- "type": "investigation"
-- },
-- "modified": "2021-02-24T23:15:23.274966+00:00",
-- "status": "published",
-- "time": {
-- "live_span": "1h"
-- }
-- }
-- }
-- ],
-- "meta": {
-- "page": {
-- "total_count": 83637833,
-- "total_filtered_count": 34015219
-- }
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @id int
DECLARE @v_type nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @Created_at nvarchar(4000)
DECLARE @Disabled int
DECLARE @v_Email nvarchar(4000)
DECLARE @Handle nvarchar(4000)
DECLARE @Icon nvarchar(4000)
DECLARE @AuthorName nvarchar(4000)
DECLARE @Status nvarchar(4000)
DECLARE @Title nvarchar(4000)
DECLARE @Verified int
DECLARE @Created nvarchar(4000)
DECLARE @Is_template int
DECLARE @Take_snapshots int
DECLARE @v_Type nvarchar(4000)
DECLARE @Modified nvarchar(4000)
DECLARE @attributesStatus nvarchar(4000)
DECLARE @Live_span nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @id_str nvarchar(4000)
DECLARE @DefinitionType nvarchar(4000)
DECLARE @Text nvarchar(4000)
DECLARE @Total_count int
EXEC sp_OAMethod @jResp, 'IntOf', @Total_count OUT, 'meta.page.total_count'
DECLARE @Total_filtered_count int
EXEC sp_OAMethod @jResp, 'IntOf', @Total_filtered_count OUT, 'meta.page.total_filtered_count'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'IntOf', @id OUT, 'data[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'data[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'data[i].attributes.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'data[i].attributes.author.created_at'
EXEC sp_OAMethod @jResp, 'BoolOf', @Disabled OUT, 'data[i].attributes.author.disabled'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Email OUT, 'data[i].attributes.author.email'
EXEC sp_OAMethod @jResp, 'StringOf', @Handle OUT, 'data[i].attributes.author.handle'
EXEC sp_OAMethod @jResp, 'StringOf', @Icon OUT, 'data[i].attributes.author.icon'
EXEC sp_OAMethod @jResp, 'StringOf', @AuthorName OUT, 'data[i].attributes.author.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Status OUT, 'data[i].attributes.author.status'
EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'data[i].attributes.author.title'
EXEC sp_OAMethod @jResp, 'BoolOf', @Verified OUT, 'data[i].attributes.author.verified'
EXEC sp_OAMethod @jResp, 'StringOf', @Created OUT, 'data[i].attributes.created'
EXEC sp_OAMethod @jResp, 'BoolOf', @Is_template OUT, 'data[i].attributes.metadata.is_template'
EXEC sp_OAMethod @jResp, 'BoolOf', @Take_snapshots OUT, 'data[i].attributes.metadata.take_snapshots'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'data[i].attributes.metadata.type'
EXEC sp_OAMethod @jResp, 'StringOf', @Modified OUT, 'data[i].attributes.modified'
EXEC sp_OAMethod @jResp, 'StringOf', @attributesStatus OUT, 'data[i].attributes.status'
EXEC sp_OAMethod @jResp, 'StringOf', @Live_span OUT, 'data[i].attributes.time.live_span'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'data[i].attributes.cells'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @id_str OUT, 'data[i].attributes.cells[j].id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'data[i].attributes.cells[j].type'
EXEC sp_OAMethod @jResp, 'StringOf', @DefinitionType OUT, 'data[i].attributes.cells[j].attributes.definition.type'
EXEC sp_OAMethod @jResp, 'StringOf', @Text OUT, 'data[i].attributes.cells[j].attributes.definition.text'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "author_handle=test%40datadoghq.com"
-d "exclude_author_handle=test%40datadoghq.com"
-d "start=0"
-d "count=5"
-d "sort_field=modified"
-d "sort_dir=desc"
-d "query=postmortem"
-d "include_cells=false"
-d "is_template=false"
-d "type=investigation"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/notebooks
Postman Collection Item JSON
{
"name": "Get all notebooks",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks?author_handle=test@datadoghq.com&exclude_author_handle=test@datadoghq.com&start=0&count=5&sort_field=modified&sort_dir=desc&query=postmortem&include_cells=false&is_template=false&type=investigation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
],
"query": [
{
"key": "author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks created by the given `author_handle`."
},
{
"key": "exclude_author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks not created by the given `author_handle`."
},
{
"key": "start",
"value": "0",
"description": "The index of the first notebook you want returned."
},
{
"key": "count",
"value": "5",
"description": "The number of notebooks to be returned."
},
{
"key": "sort_field",
"value": "modified",
"description": "Sort by field `modified`, `name`, or `created`."
},
{
"key": "sort_dir",
"value": "desc",
"description": "Sort by direction `asc` or `desc`."
},
{
"key": "query",
"value": "postmortem",
"description": "Return only notebooks with `query` string in notebook name or author handle."
},
{
"key": "include_cells",
"value": "false",
"description": "Value of `false` excludes the `cells` and global `time` for each notebook."
},
{
"key": "is_template",
"value": "false",
"description": "True value returns only template notebooks. Default is false (returns only non-template notebooks)."
},
{
"key": "type",
"value": "investigation",
"description": "If type is provided, returns only notebooks with that metadata type. Default does not have type filtering."
}
]
},
"description": "Get all notebooks. This can also be used to search for notebooks with a particular `query` in the notebook\n`name` or author `handle`."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks?author_handle=test@datadoghq.com&exclude_author_handle=test@datadoghq.com&start=0&count=5&sort_field=modified&sort_dir=desc&query=postmortem&include_cells=false&is_template=false&type=investigation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
],
"query": [
{
"key": "author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks created by the given `author_handle`."
},
{
"key": "exclude_author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks not created by the given `author_handle`."
},
{
"key": "start",
"value": "0",
"description": "The index of the first notebook you want returned."
},
{
"key": "count",
"value": "5",
"description": "The number of notebooks to be returned."
},
{
"key": "sort_field",
"value": "modified",
"description": "Sort by field `modified`, `name`, or `created`."
},
{
"key": "sort_dir",
"value": "desc",
"description": "Sort by direction `asc` or `desc`."
},
{
"key": "query",
"value": "postmortem",
"description": "Return only notebooks with `query` string in notebook name or author handle."
},
{
"key": "include_cells",
"value": "false",
"description": "Value of `false` excludes the `cells` and global `time` for each notebook."
},
{
"key": "is_template",
"value": "false",
"description": "True value returns only template notebooks. Default is false (returns only non-template notebooks)."
},
{
"key": "type",
"value": "investigation",
"description": "If type is provided, returns only notebooks with that metadata type. Default does not have type filtering."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": 123456,\n \"type\": \"notebooks\",\n \"attributes\": {\n \"name\": \"Example Notebook\",\n \"author\": {\n \"created_at\": \"1981-07-01T19:18:52.706Z\",\n \"disabled\": true,\n \"email\": \"enim fugiat\",\n \"handle\": \"in\",\n \"icon\": \"ut laborum\",\n \"name\": \"ex sunt dolore eiusmod\",\n \"status\": \"in nisi non velit adipisicing\",\n \"title\": \"veniam dolor\",\n \"verified\": false\n },\n \"cells\": [\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n },\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n }\n ],\n \"created\": \"2021-02-24T23:14:15.173964+00:00\",\n \"metadata\": {\n \"is_template\": false,\n \"take_snapshots\": false,\n \"type\": \"investigation\"\n },\n \"modified\": \"2021-02-24T23:15:23.274966+00:00\",\n \"status\": \"published\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n }\n },\n {\n \"id\": 123456,\n \"type\": \"notebooks\",\n \"attributes\": {\n \"name\": \"Example Notebook\",\n \"author\": {\n \"created_at\": \"1984-05-01T21:20:20.424Z\",\n \"disabled\": true,\n \"email\": \"cillum\",\n \"handle\": \"et in Excepteur sunt aute\",\n \"icon\": \"minim dolore sint eu deserunt\",\n \"name\": \"ex reprehenderit labore\",\n \"status\": \"dolor consectetur\",\n \"title\": \"ex ut dolore\",\n \"verified\": true\n },\n \"cells\": [\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n },\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n }\n ],\n \"created\": \"2021-02-24T23:14:15.173964+00:00\",\n \"metadata\": {\n \"is_template\": false,\n \"take_snapshots\": false,\n \"type\": \"investigation\"\n },\n \"modified\": \"2021-02-24T23:15:23.274966+00:00\",\n \"status\": \"published\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": 83637833,\n \"total_filtered_count\": 34015219\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks?author_handle=test@datadoghq.com&exclude_author_handle=test@datadoghq.com&start=0&count=5&sort_field=modified&sort_dir=desc&query=postmortem&include_cells=false&is_template=false&type=investigation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
],
"query": [
{
"key": "author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks created by the given `author_handle`."
},
{
"key": "exclude_author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks not created by the given `author_handle`."
},
{
"key": "start",
"value": "0",
"description": "The index of the first notebook you want returned."
},
{
"key": "count",
"value": "5",
"description": "The number of notebooks to be returned."
},
{
"key": "sort_field",
"value": "modified",
"description": "Sort by field `modified`, `name`, or `created`."
},
{
"key": "sort_dir",
"value": "desc",
"description": "Sort by direction `asc` or `desc`."
},
{
"key": "query",
"value": "postmortem",
"description": "Return only notebooks with `query` string in notebook name or author handle."
},
{
"key": "include_cells",
"value": "false",
"description": "Value of `false` excludes the `cells` and global `time` for each notebook."
},
{
"key": "is_template",
"value": "false",
"description": "True value returns only template notebooks. Default is false (returns only non-template notebooks)."
},
{
"key": "type",
"value": "investigation",
"description": "If type is provided, returns only notebooks with that metadata type. Default does not have type filtering."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks?author_handle=test@datadoghq.com&exclude_author_handle=test@datadoghq.com&start=0&count=5&sort_field=modified&sort_dir=desc&query=postmortem&include_cells=false&is_template=false&type=investigation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
],
"query": [
{
"key": "author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks created by the given `author_handle`."
},
{
"key": "exclude_author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks not created by the given `author_handle`."
},
{
"key": "start",
"value": "0",
"description": "The index of the first notebook you want returned."
},
{
"key": "count",
"value": "5",
"description": "The number of notebooks to be returned."
},
{
"key": "sort_field",
"value": "modified",
"description": "Sort by field `modified`, `name`, or `created`."
},
{
"key": "sort_dir",
"value": "desc",
"description": "Sort by direction `asc` or `desc`."
},
{
"key": "query",
"value": "postmortem",
"description": "Return only notebooks with `query` string in notebook name or author handle."
},
{
"key": "include_cells",
"value": "false",
"description": "Value of `false` excludes the `cells` and global `time` for each notebook."
},
{
"key": "is_template",
"value": "false",
"description": "True value returns only template notebooks. Default is false (returns only non-template notebooks)."
},
{
"key": "type",
"value": "investigation",
"description": "If type is provided, returns only notebooks with that metadata type. Default does not have type filtering."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks?author_handle=test@datadoghq.com&exclude_author_handle=test@datadoghq.com&start=0&count=5&sort_field=modified&sort_dir=desc&query=postmortem&include_cells=false&is_template=false&type=investigation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
],
"query": [
{
"key": "author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks created by the given `author_handle`."
},
{
"key": "exclude_author_handle",
"value": "test@datadoghq.com",
"description": "Return notebooks not created by the given `author_handle`."
},
{
"key": "start",
"value": "0",
"description": "The index of the first notebook you want returned."
},
{
"key": "count",
"value": "5",
"description": "The number of notebooks to be returned."
},
{
"key": "sort_field",
"value": "modified",
"description": "Sort by field `modified`, `name`, or `created`."
},
{
"key": "sort_dir",
"value": "desc",
"description": "Sort by direction `asc` or `desc`."
},
{
"key": "query",
"value": "postmortem",
"description": "Return only notebooks with `query` string in notebook name or author handle."
},
{
"key": "include_cells",
"value": "false",
"description": "Value of `false` excludes the `cells` and global `time` for each notebook."
},
{
"key": "is_template",
"value": "false",
"description": "True value returns only template notebooks. Default is false (returns only non-template notebooks)."
},
{
"key": "type",
"value": "investigation",
"description": "If type is provided, returns only notebooks with that metadata type. Default does not have type filtering."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
