Chilkat Online Tools

Xojo / Datadog API Collection / Monitors search

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 Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("query","tempor Ut sed velit")
success = queryParams.UpdateInt("page",0)
success = queryParams.UpdateInt("per_page",30)
success = queryParams.UpdateString("sort","tempor Ut sed velit")

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

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/monitor/search",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// 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

Dim count As Int32
Dim name As Boolean
Dim name_str As String
Dim classification As String
Dim Handle As String
Dim Name As String
Dim id As Int32
Dim last_triggered_ts As String
Dim org_id As Int32
Dim status As String
Dim v_type As String
Dim j As Int32
Dim count_j As Int32
Dim strVal As String
Dim handle As String

Dim Page As Int32
Page = jResp.IntOf("metadata.page")
Dim Page_count As Int32
Page_count = jResp.IntOf("metadata.page_count")
Dim Per_page As Int32
Per_page = jResp.IntOf("metadata.per_page")
Dim Total_count As Int32
Total_count = jResp.IntOf("metadata.total_count")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("counts.muted")
While i < count_i
    jResp.I = i
    count = jResp.IntOf("counts.muted[i].count")
    name = jResp.BoolOf("counts.muted[i].name")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("counts.status")
While i < count_i
    jResp.I = i
    count = jResp.IntOf("counts.status[i].count")
    name_str = jResp.StringOf("counts.status[i].name")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("counts.tag")
While i < count_i
    jResp.I = i
    count = jResp.IntOf("counts.tag[i].count")
    name_str = jResp.StringOf("counts.tag[i].name")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("counts.type")
While i < count_i
    jResp.I = i
    count = jResp.IntOf("counts.type[i].count")
    name_str = jResp.StringOf("counts.type[i].name")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("monitors")
While i < count_i
    jResp.I = i
    classification = jResp.StringOf("monitors[i].classification")
    Handle = jResp.StringOf("monitors[i].creator.handle")
    Name = jResp.StringOf("monitors[i].creator.name")
    id = jResp.IntOf("monitors[i].id")
    last_triggered_ts = jResp.StringOf("monitors[i].last_triggered_ts")
    name_str = jResp.StringOf("monitors[i].name")
    org_id = jResp.IntOf("monitors[i].org_id")
    status = jResp.StringOf("monitors[i].status")
    v_type = jResp.StringOf("monitors[i].type")
    j = 0
    count_j = jResp.SizeOfArray("monitors[i].metrics")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("monitors[i].metrics[j]")
        j = j + 1
    Wend
    j = 0
    count_j = jResp.SizeOfArray("monitors[i].notifications")
    While j < count_j
        jResp.J = j
        handle = jResp.StringOf("monitors[i].notifications[j].handle")
        name_str = jResp.StringOf("monitors[i].notifications[j].name")
        j = j + 1
    Wend
    j = 0
    count_j = jResp.SizeOfArray("monitors[i].scopes")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("monitors[i].scopes[j]")
        j = j + 1
    Wend
    j = 0
    count_j = jResp.SizeOfArray("monitors[i].tags")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("monitors[i].tags[j]")
        j = j + 1
    Wend
    i = i + 1
Wend

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}"
    }
  ]
}