Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_Id
string ls_V_type
string ls_Name
string ls_Created_at
integer li_Disabled
string ls_V_Email
string ls_Handle
string ls_Icon
string ls_AuthorName
string ls_Status
string ls_Title
integer li_Verified
string ls_Created
integer li_Is_template
integer li_Take_snapshots
string ls_V_Type
string ls_Modified
string ls_AttributesStatus
string ls_Live_span
integer j
integer li_Count_j
string ls_Id_str
string ls_DefinitionType
string ls_Text
integer li_Total_count
integer li_Total_filtered_count
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("author_handle","test@datadoghq.com")
loo_QueryParams.UpdateString("exclude_author_handle","test@datadoghq.com")
loo_QueryParams.UpdateInt("start",0)
loo_QueryParams.UpdateInt("count",5)
loo_QueryParams.UpdateString("sort_field","modified")
loo_QueryParams.UpdateString("sort_dir","desc")
loo_QueryParams.UpdateString("query","postmortem")
loo_QueryParams.UpdateString("include_cells","false")
loo_QueryParams.UpdateString("is_template","false")
loo_QueryParams.UpdateString("type","investigation")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/notebooks",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
li_Total_count = loo_JResp.IntOf("meta.page.total_count")
li_Total_filtered_count = loo_JResp.IntOf("meta.page.total_filtered_count")
i = 0
li_Count_i = loo_JResp.SizeOfArray("data")
do while i < li_Count_i
loo_JResp.I = i
li_Id = loo_JResp.IntOf("data[i].id")
ls_V_type = loo_JResp.StringOf("data[i].type")
ls_Name = loo_JResp.StringOf("data[i].attributes.name")
ls_Created_at = loo_JResp.StringOf("data[i].attributes.author.created_at")
li_Disabled = loo_JResp.BoolOf("data[i].attributes.author.disabled")
ls_V_Email = loo_JResp.StringOf("data[i].attributes.author.email")
ls_Handle = loo_JResp.StringOf("data[i].attributes.author.handle")
ls_Icon = loo_JResp.StringOf("data[i].attributes.author.icon")
ls_AuthorName = loo_JResp.StringOf("data[i].attributes.author.name")
ls_Status = loo_JResp.StringOf("data[i].attributes.author.status")
ls_Title = loo_JResp.StringOf("data[i].attributes.author.title")
li_Verified = loo_JResp.BoolOf("data[i].attributes.author.verified")
ls_Created = loo_JResp.StringOf("data[i].attributes.created")
li_Is_template = loo_JResp.BoolOf("data[i].attributes.metadata.is_template")
li_Take_snapshots = loo_JResp.BoolOf("data[i].attributes.metadata.take_snapshots")
ls_V_Type = loo_JResp.StringOf("data[i].attributes.metadata.type")
ls_Modified = loo_JResp.StringOf("data[i].attributes.modified")
ls_AttributesStatus = loo_JResp.StringOf("data[i].attributes.status")
ls_Live_span = loo_JResp.StringOf("data[i].attributes.time.live_span")
j = 0
li_Count_j = loo_JResp.SizeOfArray("data[i].attributes.cells")
do while j < li_Count_j
loo_JResp.J = j
ls_Id_str = loo_JResp.StringOf("data[i].attributes.cells[j].id")
ls_V_type = loo_JResp.StringOf("data[i].attributes.cells[j].type")
ls_DefinitionType = loo_JResp.StringOf("data[i].attributes.cells[j].attributes.definition.type")
ls_Text = loo_JResp.StringOf("data[i].attributes.cells[j].attributes.definition.text")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
