Chilkat Online Tools

Swift3 / Datadog API Collection / Monitors search

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

    let queryParams = CkoJsonObject()!
    queryParams.update("query", value: "tempor Ut sed velit")
    queryParams.updateInt("page", value: 0)
    queryParams.updateInt("per_page", value: 30)
    queryParams.update("sort", value: "tempor Ut sed velit")

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

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.app.ddog-gov.com/api/v1/monitor/search", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "counts": {
    //     "muted": [
    //       {
    //         "count": 3,
    //         "name": false
    //       },
    //       {
    //         "count": 3,
    //         "name": true
    //       }
    //     ],
    //     "status": [
    //       {
    //         "count": 4,
    //         "name": "No Data"
    //       },
    //       {
    //         "count": 2,
    //         "name": "OK"
    //       }
    //     ],
    //     "tag": [
    //       {
    //         "count": 6,
    //         "name": "service:cassandra"
    //       }
    //     ],
    //     "type": [
    //       {
    //         "count": 6,
    //         "name": "metric"
    //       }
    //     ]
    //   },
    //   "metadata": {
    //     "page": 0,
    //     "page_count": 6,
    //     "per_page": 30,
    //     "total_count": 6
    //   },
    //   "monitors": [
    //     {
    //       "classification": "metric",
    //       "creator": {
    //         "handle": "john@datadoghq.com",
    //         "name": "John Doe"
    //       },
    //       "id": 2699850,
    //       "last_triggered_ts": null,
    //       "metrics": [
    //         "system.cpu.user"
    //       ],
    //       "name": "Cassandra CPU is high on {{host.name}} in {{availability-zone.name}}",
    //       "notifications": [
    //         {
    //           "handle": "jane@datadoghq.com",
    //           "name": "Jane Doe"
    //         }
    //       ],
    //       "org_id": 1234,
    //       "scopes": [
    //         "!availability-zone:us-east-1c",
    //         "name:cassandra"
    //       ],
    //       "status": "No Data",
    //       "tags": [
    //         "service:cassandra"
    //       ],
    //       "type": "query alert"
    //     }
    //   ]
    // }

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

    var count: Int
    var name: Bool
    var name_str: String?
    var classification: String?
    var Handle: String?
    var Name: String?
    var id: Int
    var last_triggered_ts: String?
    var org_id: Int
    var status: String?
    var v_type: String?
    var j: Int
    var count_j: Int
    var strVal: String?
    var handle: String?

    var Page: Int = jResp.int(of: "metadata.page").intValue
    var Page_count: Int = jResp.int(of: "metadata.page_count").intValue
    var Per_page: Int = jResp.int(of: "metadata.per_page").intValue
    var Total_count: Int = jResp.int(of: "metadata.total_count").intValue
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "counts.muted").intValue
    while i < count_i {
        jResp.i = i
        count = jResp.int(of: "counts.muted[i].count").intValue
        name = jResp.bool(of: "counts.muted[i].name")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "counts.status").intValue
    while i < count_i {
        jResp.i = i
        count = jResp.int(of: "counts.status[i].count").intValue
        name_str = jResp.string(of: "counts.status[i].name")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "counts.tag").intValue
    while i < count_i {
        jResp.i = i
        count = jResp.int(of: "counts.tag[i].count").intValue
        name_str = jResp.string(of: "counts.tag[i].name")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "counts.type").intValue
    while i < count_i {
        jResp.i = i
        count = jResp.int(of: "counts.type[i].count").intValue
        name_str = jResp.string(of: "counts.type[i].name")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "monitors").intValue
    while i < count_i {
        jResp.i = i
        classification = jResp.string(of: "monitors[i].classification")
        Handle = jResp.string(of: "monitors[i].creator.handle")
        Name = jResp.string(of: "monitors[i].creator.name")
        id = jResp.int(of: "monitors[i].id").intValue
        last_triggered_ts = jResp.string(of: "monitors[i].last_triggered_ts")
        name_str = jResp.string(of: "monitors[i].name")
        org_id = jResp.int(of: "monitors[i].org_id").intValue
        status = jResp.string(of: "monitors[i].status")
        v_type = jResp.string(of: "monitors[i].type")
        j = 0
        count_j = jResp.size(ofArray: "monitors[i].metrics").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "monitors[i].metrics[j]")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "monitors[i].notifications").intValue
        while j < count_j {
            jResp.j = j
            handle = jResp.string(of: "monitors[i].notifications[j].handle")
            name_str = jResp.string(of: "monitors[i].notifications[j].name")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "monitors[i].scopes").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "monitors[i].scopes[j]")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "monitors[i].tags").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "monitors[i].tags[j]")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl -G -d "query=tempor%20Ut%20sed%20velit"
	-d "page=0"
	-d "per_page=30"
	-d "sort=tempor%20Ut%20sed%20velit"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/monitor/search

Postman Collection Item JSON

{
  "name": "Monitors search",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/monitor/search?query=tempor Ut sed velit&page=0&per_page=30&sort=tempor Ut sed velit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "monitor",
        "search"
      ],
      "query": [
        {
          "key": "query",
          "value": "tempor Ut sed velit",
          "description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
        },
        {
          "key": "page",
          "value": "0",
          "description": "Page to start paginating from."
        },
        {
          "key": "per_page",
          "value": "30",
          "description": "Number of monitors to return per page."
        },
        {
          "key": "sort",
          "value": "tempor Ut sed velit",
          "description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
        }
      ]
    },
    "description": "Search and filter your monitors details."
  },
  "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/monitor/search?query=tempor Ut sed velit&page=0&per_page=30&sort=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "monitor",
            "search"
          ],
          "query": [
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
            },
            {
              "key": "page",
              "value": "0",
              "description": "Page to start paginating from."
            },
            {
              "key": "per_page",
              "value": "30",
              "description": "Number of monitors to return per page."
            },
            {
              "key": "sort",
              "value": "tempor Ut sed velit",
              "description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"counts\": {\n    \"muted\": [\n      {\n        \"count\": 3,\n        \"name\": false\n      },\n      {\n        \"count\": 3,\n        \"name\": true\n      }\n    ],\n    \"status\": [\n      {\n        \"count\": 4,\n        \"name\": \"No Data\"\n      },\n      {\n        \"count\": 2,\n        \"name\": \"OK\"\n      }\n    ],\n    \"tag\": [\n      {\n        \"count\": 6,\n        \"name\": \"service:cassandra\"\n      }\n    ],\n    \"type\": [\n      {\n        \"count\": 6,\n        \"name\": \"metric\"\n      }\n    ]\n  },\n  \"metadata\": {\n    \"page\": 0,\n    \"page_count\": 6,\n    \"per_page\": 30,\n    \"total_count\": 6\n  },\n  \"monitors\": [\n    {\n      \"classification\": \"metric\",\n      \"creator\": {\n        \"handle\": \"john@datadoghq.com\",\n        \"name\": \"John Doe\"\n      },\n      \"id\": 2699850,\n      \"last_triggered_ts\": null,\n      \"metrics\": [\n        \"system.cpu.user\"\n      ],\n      \"name\": \"Cassandra CPU is high on {{host.name}} in {{availability-zone.name}}\",\n      \"notifications\": [\n        {\n          \"handle\": \"jane@datadoghq.com\",\n          \"name\": \"Jane Doe\"\n        }\n      ],\n      \"org_id\": 1234,\n      \"scopes\": [\n        \"!availability-zone:us-east-1c\",\n        \"name:cassandra\"\n      ],\n      \"status\": \"No Data\",\n      \"tags\": [\n        \"service:cassandra\"\n      ],\n      \"type\": \"query alert\"\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/monitor/search?query=tempor Ut sed velit&page=0&per_page=30&sort=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "monitor",
            "search"
          ],
          "query": [
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
            },
            {
              "key": "page",
              "value": "0",
              "description": "Page to start paginating from."
            },
            {
              "key": "per_page",
              "value": "30",
              "description": "Number of monitors to return per page."
            },
            {
              "key": "sort",
              "value": "tempor Ut sed velit",
              "description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
            }
          ]
        }
      },
      "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": "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/monitor/search?query=tempor Ut sed velit&page=0&per_page=30&sort=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "monitor",
            "search"
          ],
          "query": [
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
            },
            {
              "key": "page",
              "value": "0",
              "description": "Page to start paginating from."
            },
            {
              "key": "per_page",
              "value": "30",
              "description": "Number of monitors to return per page."
            },
            {
              "key": "sort",
              "value": "tempor Ut sed velit",
              "description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
            }
          ]
        }
      },
      "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/monitor/search?query=tempor Ut sed velit&page=0&per_page=30&sort=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "monitor",
            "search"
          ],
          "query": [
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
            },
            {
              "key": "page",
              "value": "0",
              "description": "Page to start paginating from."
            },
            {
              "key": "per_page",
              "value": "30",
              "description": "Number of monitors to return per page."
            },
            {
              "key": "sort",
              "value": "tempor Ut sed velit",
              "description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
            }
          ]
        }
      },
      "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}"
    }
  ]
}