Chilkat Online Tools

Swift / Datadog API Collection / Get active downtimes for a monitor

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/monitor/:monitor_id/downtime_matches", 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)

    // {
    //   "data": [
    //     {
    //       "attributes": {
    //         "end": "<dateTime>",
    //         "groups": [
    //           "<string>",
    //           "<string>"
    //         ],
    //         "scope": "<string>",
    //         "start": "<dateTime>"
    //       },
    //       "id": "<string>",
    //       "type": "downtime_match"
    //     },
    //     {
    //       "attributes": {
    //         "end": "<dateTime>",
    //         "groups": [
    //           "<string>",
    //           "<string>"
    //         ],
    //         "scope": "<string>",
    //         "start": "<dateTime>"
    //       },
    //       "id": "<string>",
    //       "type": "downtime_match"
    //     }
    //   ],
    //   "meta": {
    //     "page": {
    //       "total_filtered_count": "<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_End: String?
    var Scope: String?
    var Start: String?
    var id: String?
    var v_type: String?
    var j: Int
    var count_j: Int
    var strVal: String?

    var Total_filtered_count: String? = jResp.StringOf("meta.page.total_filtered_count")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("data").intValue
    while i < count_i {
        jResp.I = i
        v_End = jResp.StringOf("data[i].attributes.end")
        Scope = jResp.StringOf("data[i].attributes.scope")
        Start = jResp.StringOf("data[i].attributes.start")
        id = jResp.StringOf("data[i].id")
        v_type = jResp.StringOf("data[i].type")
        j = 0
        count_j = jResp.SizeOfArray("data[i].attributes.groups").intValue
        while j < count_j {
            jResp.J = j
            strVal = jResp.StringOf("data[i].attributes.groups[j]")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/monitor/:monitor_id/downtime_matches

Postman Collection Item JSON

{
  "name": "Get active downtimes for a monitor",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/monitor/:monitor_id/downtime_matches",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "monitor",
        ":monitor_id",
        "downtime_matches"
      ],
      "variable": [
        {
          "key": "monitor_id",
          "value": "<long>"
        }
      ]
    },
    "description": "Get all active downtimes for the specified monitor."
  },
  "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/monitor/:monitor_id/downtime_matches",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "monitor",
            ":monitor_id",
            "downtime_matches"
          ],
          "variable": [
            {
              "key": "monitor_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"attributes\": {\n        \"end\": \"<dateTime>\",\n        \"groups\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"scope\": \"<string>\",\n        \"start\": \"<dateTime>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"downtime_match\"\n    },\n    {\n      \"attributes\": {\n        \"end\": \"<dateTime>\",\n        \"groups\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"scope\": \"<string>\",\n        \"start\": \"<dateTime>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"downtime_match\"\n    }\n  ],\n  \"meta\": {\n    \"page\": {\n      \"total_filtered_count\": \"<long>\"\n    }\n  }\n}"
    },
    {
      "name": "Monitor Not Found 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/v2/monitor/:monitor_id/downtime_matches",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "monitor",
            ":monitor_id",
            "downtime_matches"
          ],
          "variable": [
            {
              "key": "monitor_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/monitor/:monitor_id/downtime_matches",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "monitor",
            ":monitor_id",
            "downtime_matches"
          ],
          "variable": [
            {
              "key": "monitor_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}"
    }
  ]
}