Chilkat Online Tools

Swift / Datadog API Collection / Get items of a Dashboard List

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    http.SetRequestHeader("Accept", value: "application/json")

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

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

    // {
    //   "dashboards": [
    //     {
    //       "type": "host_timeboard",
    //       "id": "<string>",
    //       "author": {
    //         "email": "<string>",
    //         "handle": "<string>",
    //         "name": "<string>"
    //       },
    //       "created": "<dateTime>",
    //       "icon": "<string>",
    //       "integration_id": "<string>",
    //       "is_favorite": "<boolean>",
    //       "is_read_only": "<boolean>",
    //       "is_shared": "<boolean>",
    //       "modified": "<dateTime>",
    //       "popularity": "<integer>",
    //       "tags": [
    //         "<string>",
    //         "<string>"
    //       ],
    //       "title": "<string>",
    //       "url": "<string>"
    //     },
    //     {
    //       "type": "custom_screenboard",
    //       "id": "<string>",
    //       "author": {
    //         "email": "<string>",
    //         "handle": "<string>",
    //         "name": "<string>"
    //       },
    //       "created": "<dateTime>",
    //       "icon": "<string>",
    //       "integration_id": "<string>",
    //       "is_favorite": "<boolean>",
    //       "is_read_only": "<boolean>",
    //       "is_shared": "<boolean>",
    //       "modified": "<dateTime>",
    //       "popularity": "<integer>",
    //       "tags": [
    //         "<string>",
    //         "<string>"
    //       ],
    //       "title": "<string>",
    //       "url": "<string>"
    //     }
    //   ],
    //   "total": "<long>"
    // }

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

    var v_type: String?
    var id: String?
    var v_Email: String?
    var Handle: String?
    var Name: String?
    var created: String?
    var icon: String?
    var integration_id: String?
    var is_favorite: String?
    var is_read_only: String?
    var is_shared: String?
    var modified: String?
    var popularity: String?
    var title: String?
    var url: String?
    var j: Int
    var count_j: Int
    var strVal: String?

    var total: String? = jResp.StringOf("total")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("dashboards").intValue
    while i < count_i {
        jResp.I = i
        v_type = jResp.StringOf("dashboards[i].type")
        id = jResp.StringOf("dashboards[i].id")
        v_Email = jResp.StringOf("dashboards[i].author.email")
        Handle = jResp.StringOf("dashboards[i].author.handle")
        Name = jResp.StringOf("dashboards[i].author.name")
        created = jResp.StringOf("dashboards[i].created")
        icon = jResp.StringOf("dashboards[i].icon")
        integration_id = jResp.StringOf("dashboards[i].integration_id")
        is_favorite = jResp.StringOf("dashboards[i].is_favorite")
        is_read_only = jResp.StringOf("dashboards[i].is_read_only")
        is_shared = jResp.StringOf("dashboards[i].is_shared")
        modified = jResp.StringOf("dashboards[i].modified")
        popularity = jResp.StringOf("dashboards[i].popularity")
        title = jResp.StringOf("dashboards[i].title")
        url = jResp.StringOf("dashboards[i].url")
        j = 0
        count_j = jResp.SizeOfArray("dashboards[i].tags").intValue
        while j < count_j {
            jResp.J = j
            strVal = jResp.StringOf("dashboards[i].tags[j]")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get items of a Dashboard List",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dashboard",
        "lists",
        "manual",
        ":dashboard_list_id",
        "dashboards"
      ],
      "variable": [
        {
          "key": "dashboard_list_id",
          "value": "<long>"
        }
      ]
    },
    "description": "Fetch the dashboard list’s dashboard 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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dashboard",
            "lists",
            "manual",
            ":dashboard_list_id",
            "dashboards"
          ],
          "variable": [
            {
              "key": "dashboard_list_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"dashboards\": [\n    {\n      \"type\": \"host_timeboard\",\n      \"id\": \"<string>\",\n      \"author\": {\n        \"email\": \"<string>\",\n        \"handle\": \"<string>\",\n        \"name\": \"<string>\"\n      },\n      \"created\": \"<dateTime>\",\n      \"icon\": \"<string>\",\n      \"integration_id\": \"<string>\",\n      \"is_favorite\": \"<boolean>\",\n      \"is_read_only\": \"<boolean>\",\n      \"is_shared\": \"<boolean>\",\n      \"modified\": \"<dateTime>\",\n      \"popularity\": \"<integer>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"title\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"type\": \"custom_screenboard\",\n      \"id\": \"<string>\",\n      \"author\": {\n        \"email\": \"<string>\",\n        \"handle\": \"<string>\",\n        \"name\": \"<string>\"\n      },\n      \"created\": \"<dateTime>\",\n      \"icon\": \"<string>\",\n      \"integration_id\": \"<string>\",\n      \"is_favorite\": \"<boolean>\",\n      \"is_read_only\": \"<boolean>\",\n      \"is_shared\": \"<boolean>\",\n      \"modified\": \"<dateTime>\",\n      \"popularity\": \"<integer>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"title\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ],\n  \"total\": \"<long>\"\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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dashboard",
            "lists",
            "manual",
            ":dashboard_list_id",
            "dashboards"
          ],
          "variable": [
            {
              "key": "dashboard_list_id"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Not Found",
      "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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dashboard",
            "lists",
            "manual",
            ":dashboard_list_id",
            "dashboards"
          ],
          "variable": [
            {
              "key": "dashboard_list_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dashboard",
            "lists",
            "manual",
            ":dashboard_list_id",
            "dashboards"
          ],
          "variable": [
            {
              "key": "dashboard_list_id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}