Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("query","tempor Ut sed velit")
$oQueryParams.UpdateInt("page",0)
$oQueryParams.UpdateInt("per_page",30)
$oQueryParams.UpdateString("sort","tempor Ut sed velit")
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/monitor/search",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $iCount
Local $bName
Local $sName_str
Local $sClassification
Local $sHandle
Local $sName
Local $id
Local $sLast_triggered_ts
Local $iOrg_id
Local $status
Local $sV_type
Local $iJ
Local $iCount_j
Local $strVal
Local $sHandle
Local $iPage = $oJResp.IntOf("metadata.page")
Local $iPage_count = $oJResp.IntOf("metadata.page_count")
Local $iPer_page = $oJResp.IntOf("metadata.per_page")
Local $iTotal_count = $oJResp.IntOf("metadata.total_count")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("counts.muted")
While $i < $iCount_i
$oJResp.I = $i
$iCount = $oJResp.IntOf("counts.muted[i].count")
$bName = $oJResp.BoolOf("counts.muted[i].name")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("counts.status")
While $i < $iCount_i
$oJResp.I = $i
$iCount = $oJResp.IntOf("counts.status[i].count")
$sName_str = $oJResp.StringOf("counts.status[i].name")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("counts.tag")
While $i < $iCount_i
$oJResp.I = $i
$iCount = $oJResp.IntOf("counts.tag[i].count")
$sName_str = $oJResp.StringOf("counts.tag[i].name")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("counts.type")
While $i < $iCount_i
$oJResp.I = $i
$iCount = $oJResp.IntOf("counts.type[i].count")
$sName_str = $oJResp.StringOf("counts.type[i].name")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("monitors")
While $i < $iCount_i
$oJResp.I = $i
$sClassification = $oJResp.StringOf("monitors[i].classification")
$sHandle = $oJResp.StringOf("monitors[i].creator.handle")
$sName = $oJResp.StringOf("monitors[i].creator.name")
$id = $oJResp.IntOf("monitors[i].id")
$sLast_triggered_ts = $oJResp.StringOf("monitors[i].last_triggered_ts")
$sName_str = $oJResp.StringOf("monitors[i].name")
$iOrg_id = $oJResp.IntOf("monitors[i].org_id")
$status = $oJResp.StringOf("monitors[i].status")
$sV_type = $oJResp.StringOf("monitors[i].type")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("monitors[i].metrics")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("monitors[i].metrics[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("monitors[i].notifications")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sHandle = $oJResp.StringOf("monitors[i].notifications[j].handle")
$sName_str = $oJResp.StringOf("monitors[i].notifications[j].name")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("monitors[i].scopes")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("monitors[i].scopes[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("monitors[i].tags")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("monitors[i].tags[j]")
$iJ = $iJ + 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}"
}
]
}
