Chilkat Online Tools

PureBasic / Datadog API Collection / Create a notebook

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "data": {
    ;     "attributes": {
    ;       "cells": [
    ;         {
    ;           "attributes": {
    ;             "definition": {
    ;               "text": "## Some test markdown\n\nWith some example content.",
    ;               "type": "markdown"
    ;             }
    ;           },
    ;           "type": "notebook_cells"
    ;         },
    ;         {
    ;           "attributes": {
    ;             "definition": {
    ;               "requests": [
    ;                 {
    ;                   "display_type": "line",
    ;                   "q": "avg:system.load.1{*}",
    ;                   "style": {
    ;                     "line_type": "solid",
    ;                     "line_width": "normal",
    ;                     "palette": "dog_classic"
    ;                   }
    ;                 }
    ;               ],
    ;               "show_legend": true,
    ;               "type": "timeseries",
    ;               "yaxis": {
    ;                 "scale": "linear"
    ;               }
    ;             },
    ;             "graph_size": "m",
    ;             "split_by": {
    ;               "keys": [
    ;               ],
    ;               "tags": [
    ;               ]
    ;             },
    ;             "time": null
    ;           },
    ;           "type": "notebook_cells"
    ;         }
    ;       ],
    ;       "name": "Example Notebook",
    ;       "time": {
    ;         "live_span": "1h"
    ;       }
    ;     },
    ;     "type": "notebooks"
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"data.attributes.cells[0].attributes.definition.text","## Some test markdown" + Chr(10) + Chr(10) + "With some example content.")
    CkJsonObject::ckUpdateString(json,"data.attributes.cells[0].attributes.definition.type","markdown")
    CkJsonObject::ckUpdateString(json,"data.attributes.cells[0].type","notebook_cells")
    CkJsonObject::ckUpdateString(json,"data.attributes.cells[1].attributes.definition.requests[0].display_type","line")
    CkJsonObject::ckUpdateString(json,"data.attributes.cells[1].attributes.definition.requests[0].q","avg:system.load.1{*}")
    CkJsonObject::ckUpdateString(json,"data.attributes.cells[1].attributes.definition.requests[0].style.line_type","solid")
    CkJsonObject::ckUpdateString(json,"data.attributes.cells[1].attributes.definition.requests[0].style.line_width","normal")
    CkJsonObject::ckUpdateString(json,"data.attributes.cells[1].attributes.definition.requests[0].style.palette","dog_classic")
    CkJsonObject::ckUpdateBool(json,"data.attributes.cells[1].attributes.definition.show_legend",1)
    CkJsonObject::ckUpdateString(json,"data.attributes.cells[1].attributes.definition.type","timeseries")
    CkJsonObject::ckUpdateString(json,"data.attributes.cells[1].attributes.definition.yaxis.scale","linear")
    CkJsonObject::ckUpdateString(json,"data.attributes.cells[1].attributes.graph_size","m")
    CkJsonObject::ckUpdateNewArray(json,"data.attributes.cells[1].attributes.split_by.keys")
    CkJsonObject::ckUpdateNewArray(json,"data.attributes.cells[1].attributes.split_by.tags")
    CkJsonObject::ckUpdateNull(json,"data.attributes.cells[1].attributes.time")
    CkJsonObject::ckUpdateString(json,"data.attributes.cells[1].type","notebook_cells")
    CkJsonObject::ckUpdateString(json,"data.attributes.name","Example Notebook")
    CkJsonObject::ckUpdateString(json,"data.attributes.time.live_span","1h")
    CkJsonObject::ckUpdateString(json,"data.type","notebooks")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://api.app.ddog-gov.com/api/v1/notebooks","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "data": {
    ;     "id": 123456,
    ;     "type": "notebooks",
    ;     "attributes": {
    ;       "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"
    ;             }
    ;           }
    ;         }
    ;       ],
    ;       "time": {
    ;         "live_span": "1h"
    ;       },
    ;       "name": "Example Notebook",
    ;       "author": {
    ;         "created_at": "1944-02-06T04:58:13.667Z",
    ;         "disabled": false,
    ;         "email": "tempor exercitation",
    ;         "handle": "est eu aliquip officia",
    ;         "icon": "nostrud n",
    ;         "name": "dolor dolor",
    ;         "status": "anim Ut pariatur",
    ;         "title": "eu",
    ;         "verified": true
    ;       },
    ;       "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"
    ;     }
    ;   }
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    id.s
    v_type.s
    DefinitionType.s
    Text.s

    Id.i = CkJsonObject::ckIntOf(jResp,"data.id")
    v_Type.s = CkJsonObject::ckStringOf(jResp,"data.type")
    Live_span.s = CkJsonObject::ckStringOf(jResp,"data.attributes.time.live_span")
    Name.s = CkJsonObject::ckStringOf(jResp,"data.attributes.name")
    Created_at.s = CkJsonObject::ckStringOf(jResp,"data.attributes.author.created_at")
    Disabled.i = CkJsonObject::ckBoolOf(jResp,"data.attributes.author.disabled")
    v_Email.s = CkJsonObject::ckStringOf(jResp,"data.attributes.author.email")
    Handle.s = CkJsonObject::ckStringOf(jResp,"data.attributes.author.handle")
    Icon.s = CkJsonObject::ckStringOf(jResp,"data.attributes.author.icon")
    AuthorName.s = CkJsonObject::ckStringOf(jResp,"data.attributes.author.name")
    Status.s = CkJsonObject::ckStringOf(jResp,"data.attributes.author.status")
    Title.s = CkJsonObject::ckStringOf(jResp,"data.attributes.author.title")
    Verified.i = CkJsonObject::ckBoolOf(jResp,"data.attributes.author.verified")
    Created.s = CkJsonObject::ckStringOf(jResp,"data.attributes.created")
    Is_template.i = CkJsonObject::ckBoolOf(jResp,"data.attributes.metadata.is_template")
    Take_snapshots.i = CkJsonObject::ckBoolOf(jResp,"data.attributes.metadata.take_snapshots")
    MetadataType.s = CkJsonObject::ckStringOf(jResp,"data.attributes.metadata.type")
    Modified.s = CkJsonObject::ckStringOf(jResp,"data.attributes.modified")
    AttributesStatus.s = CkJsonObject::ckStringOf(jResp,"data.attributes.status")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.attributes.cells")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckStringOf(jResp,"data.attributes.cells[i].id")
        v_type = CkJsonObject::ckStringOf(jResp,"data.attributes.cells[i].type")
        DefinitionType = CkJsonObject::ckStringOf(jResp,"data.attributes.cells[i].attributes.definition.type")
        Text = CkJsonObject::ckStringOf(jResp,"data.attributes.cells[i].attributes.definition.text")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "attributes": {
      "cells": [
        {
          "attributes": {
            "definition": {
              "text": "## Some test markdown\n\nWith some example content.",
              "type": "markdown"
            }
          },
          "type": "notebook_cells"
        },
        {
          "attributes": {
            "definition": {
              "requests": [
                {
                  "display_type": "line",
                  "q": "avg:system.load.1{*}",
                  "style": {
                    "line_type": "solid",
                    "line_width": "normal",
                    "palette": "dog_classic"
                  }
                }
              ],
              "show_legend": true,
              "type": "timeseries",
              "yaxis": {
                "scale": "linear"
              }
            },
            "graph_size": "m",
            "split_by": {
              "keys": [],
              "tags": []
            },
            "time": null
          },
          "type": "notebook_cells"
        }
      ],
      "name": "Example Notebook",
      "time": {
        "live_span": "1h"
      }
    },
    "type": "notebooks"
  }
}'
https://api.app.ddog-gov.com/api/v1/notebooks

Postman Collection Item JSON

{
  "name": "Create a notebook",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"cells\": [\n        {\n          \"attributes\": {\n            \"definition\": {\n              \"text\": \"## Some test markdown\\n\\nWith some example content.\",\n              \"type\": \"markdown\"\n            }\n          },\n          \"type\": \"notebook_cells\"\n        },\n        {\n          \"attributes\": {\n            \"definition\": {\n              \"requests\": [\n                {\n                  \"display_type\": \"line\",\n                  \"q\": \"avg:system.load.1{*}\",\n                  \"style\": {\n                    \"line_type\": \"solid\",\n                    \"line_width\": \"normal\",\n                    \"palette\": \"dog_classic\"\n                  }\n                }\n              ],\n              \"show_legend\": true,\n              \"type\": \"timeseries\",\n              \"yaxis\": {\n                \"scale\": \"linear\"\n              }\n            },\n            \"graph_size\": \"m\",\n            \"split_by\": {\n              \"keys\": [],\n              \"tags\": []\n            },\n            \"time\": null\n          },\n          \"type\": \"notebook_cells\"\n        }\n      ],\n      \"name\": \"Example Notebook\",\n      \"time\": {\n        \"live_span\": \"1h\"\n      }\n    },\n    \"type\": \"notebooks\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/notebooks",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "notebooks"
      ]
    },
    "description": "Create a notebook using the specified options."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"cells\": [\n        {\n          \"attributes\": {\n            \"definition\": {\n              \"text\": \"## Some test markdown\\n\\nWith some example content.\",\n              \"type\": \"markdown\"\n            }\n          },\n          \"type\": \"notebook_cells\"\n        },\n        {\n          \"attributes\": {\n            \"definition\": {\n              \"requests\": [\n                {\n                  \"display_type\": \"line\",\n                  \"q\": \"avg:system.load.1{*}\",\n                  \"style\": {\n                    \"line_type\": \"solid\",\n                    \"line_width\": \"normal\",\n                    \"palette\": \"dog_classic\"\n                  }\n                }\n              ],\n              \"show_legend\": true,\n              \"type\": \"timeseries\",\n              \"yaxis\": {\n                \"scale\": \"linear\"\n              }\n            },\n            \"graph_size\": \"m\",\n            \"split_by\": {\n              \"keys\": [],\n              \"tags\": []\n            },\n            \"time\": null\n          },\n          \"type\": \"notebook_cells\"\n        }\n      ],\n      \"name\": \"Example Notebook\",\n      \"time\": {\n        \"live_span\": \"1h\"\n      }\n    },\n    \"type\": \"notebooks\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/notebooks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "notebooks"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"id\": 123456,\n    \"type\": \"notebooks\",\n    \"attributes\": {\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      \"time\": {\n        \"live_span\": \"1h\"\n      },\n      \"name\": \"Example Notebook\",\n      \"author\": {\n        \"created_at\": \"1944-02-06T04:58:13.667Z\",\n        \"disabled\": false,\n        \"email\": \"tempor exercitation\",\n        \"handle\": \"est eu aliquip officia\",\n        \"icon\": \"nostrud n\",\n        \"name\": \"dolor dolor\",\n        \"status\": \"anim Ut pariatur\",\n        \"title\": \"eu\",\n        \"verified\": true\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    }\n  }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"cells\": [\n        {\n          \"attributes\": {\n            \"definition\": {\n              \"text\": \"## Some test markdown\\n\\nWith some example content.\",\n              \"type\": \"markdown\"\n            }\n          },\n          \"type\": \"notebook_cells\"\n        },\n        {\n          \"attributes\": {\n            \"definition\": {\n              \"requests\": [\n                {\n                  \"display_type\": \"line\",\n                  \"q\": \"avg:system.load.1{*}\",\n                  \"style\": {\n                    \"line_type\": \"solid\",\n                    \"line_width\": \"normal\",\n                    \"palette\": \"dog_classic\"\n                  }\n                }\n              ],\n              \"show_legend\": true,\n              \"type\": \"timeseries\",\n              \"yaxis\": {\n                \"scale\": \"linear\"\n              }\n            },\n            \"graph_size\": \"m\",\n            \"split_by\": {\n              \"keys\": [],\n              \"tags\": []\n            },\n            \"time\": null\n          },\n          \"type\": \"notebook_cells\"\n        }\n      ],\n      \"name\": \"Example Notebook\",\n      \"time\": {\n        \"live_span\": \"1h\"\n      }\n    },\n    \"type\": \"notebooks\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/notebooks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "notebooks"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"cells\": [\n        {\n          \"attributes\": {\n            \"definition\": {\n              \"text\": \"## Some test markdown\\n\\nWith some example content.\",\n              \"type\": \"markdown\"\n            }\n          },\n          \"type\": \"notebook_cells\"\n        },\n        {\n          \"attributes\": {\n            \"definition\": {\n              \"requests\": [\n                {\n                  \"display_type\": \"line\",\n                  \"q\": \"avg:system.load.1{*}\",\n                  \"style\": {\n                    \"line_type\": \"solid\",\n                    \"line_width\": \"normal\",\n                    \"palette\": \"dog_classic\"\n                  }\n                }\n              ],\n              \"show_legend\": true,\n              \"type\": \"timeseries\",\n              \"yaxis\": {\n                \"scale\": \"linear\"\n              }\n            },\n            \"graph_size\": \"m\",\n            \"split_by\": {\n              \"keys\": [],\n              \"tags\": []\n            },\n            \"time\": null\n          },\n          \"type\": \"notebook_cells\"\n        }\n      ],\n      \"name\": \"Example Notebook\",\n      \"time\": {\n        \"live_span\": \"1h\"\n      }\n    },\n    \"type\": \"notebooks\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/notebooks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "notebooks"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"cells\": [\n        {\n          \"attributes\": {\n            \"definition\": {\n              \"text\": \"## Some test markdown\\n\\nWith some example content.\",\n              \"type\": \"markdown\"\n            }\n          },\n          \"type\": \"notebook_cells\"\n        },\n        {\n          \"attributes\": {\n            \"definition\": {\n              \"requests\": [\n                {\n                  \"display_type\": \"line\",\n                  \"q\": \"avg:system.load.1{*}\",\n                  \"style\": {\n                    \"line_type\": \"solid\",\n                    \"line_width\": \"normal\",\n                    \"palette\": \"dog_classic\"\n                  }\n                }\n              ],\n              \"show_legend\": true,\n              \"type\": \"timeseries\",\n              \"yaxis\": {\n                \"scale\": \"linear\"\n              }\n            },\n            \"graph_size\": \"m\",\n            \"split_by\": {\n              \"keys\": [],\n              \"tags\": []\n            },\n            \"time\": null\n          },\n          \"type\": \"notebook_cells\"\n        }\n      ],\n      \"name\": \"Example Notebook\",\n      \"time\": {\n        \"live_span\": \"1h\"\n      }\n    },\n    \"type\": \"notebooks\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/notebooks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "notebooks"
          ]
        }
      },
      "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}"
    }
  ]
}