Chilkat Online Tools

VB6 / Datadog API Collection / Get all dashboard lists

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/dashboard/lists/manual",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

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

' {
'   "dashboard_lists": [
'     {
'       "name": "My Dashboard",
'       "author": {
'         "email": "reprehenderit nostrud",
'         "handle": "qui officia tempor",
'         "name": "ex"
'       },
'       "created": "1963-08-11T12:15:03.407Z",
'       "dashboard_count": -63891965,
'       "id": -37288260,
'       "is_favorite": true,
'       "modified": "1993-02-16T23:18:05.785Z",
'       "type": "manual_dashboard_list"
'     },
'     {
'       "name": "My Dashboard",
'       "author": {
'         "email": "Duis reprehenderit est",
'         "handle": "consequat qui esse incididunt",
'         "name": "qui non ad"
'       },
'       "created": "2012-05-31T22:35:18.125Z",
'       "dashboard_count": -45121707,
'       "id": -45358157,
'       "is_favorite": false,
'       "modified": "1966-04-15T02:24:29.676Z",
'       "type": "manual_dashboard_list"
'     }
'   ]
' }

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

Dim name As String
Dim v_Email As String
Dim Handle As String
Dim Name As String
Dim created As String
Dim dashboard_count As Long
Dim id As Long
Dim is_favorite As Long
Dim modified As String
Dim v_type As String

Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("dashboard_lists")
Do While i < count_i
    jResp.I = i
    name = jResp.StringOf("dashboard_lists[i].name")
    v_Email = jResp.StringOf("dashboard_lists[i].author.email")
    Handle = jResp.StringOf("dashboard_lists[i].author.handle")
    Name = jResp.StringOf("dashboard_lists[i].author.name")
    created = jResp.StringOf("dashboard_lists[i].created")
    dashboard_count = jResp.IntOf("dashboard_lists[i].dashboard_count")
    id = jResp.IntOf("dashboard_lists[i].id")
    is_favorite = jResp.BoolOf("dashboard_lists[i].is_favorite")
    modified = jResp.StringOf("dashboard_lists[i].modified")
    v_type = jResp.StringOf("dashboard_lists[i].type")
    i = i + 1
Loop

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/dashboard/lists/manual

Postman Collection Item JSON

{
  "name": "Get all dashboard lists",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "dashboard",
        "lists",
        "manual"
      ]
    },
    "description": "Fetch all of your existing dashboard list definitions."
  },
  "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/dashboard/lists/manual",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard",
            "lists",
            "manual"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"dashboard_lists\": [\n    {\n      \"name\": \"My Dashboard\",\n      \"author\": {\n        \"email\": \"reprehenderit nostrud\",\n        \"handle\": \"qui officia tempor\",\n        \"name\": \"ex\"\n      },\n      \"created\": \"1963-08-11T12:15:03.407Z\",\n      \"dashboard_count\": -63891965,\n      \"id\": -37288260,\n      \"is_favorite\": true,\n      \"modified\": \"1993-02-16T23:18:05.785Z\",\n      \"type\": \"manual_dashboard_list\"\n    },\n    {\n      \"name\": \"My Dashboard\",\n      \"author\": {\n        \"email\": \"Duis reprehenderit est\",\n        \"handle\": \"consequat qui esse incididunt\",\n        \"name\": \"qui non ad\"\n      },\n      \"created\": \"2012-05-31T22:35:18.125Z\",\n      \"dashboard_count\": -45121707,\n      \"id\": -45358157,\n      \"is_favorite\": false,\n      \"modified\": \"1966-04-15T02:24:29.676Z\",\n      \"type\": \"manual_dashboard_list\"\n    }\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "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/dashboard/lists/manual",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard",
            "lists",
            "manual"
          ]
        }
      },
      "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/dashboard/lists/manual",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard",
            "lists",
            "manual"
          ]
        }
      },
      "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}"
    }
  ]
}