Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnCount
LOCAL lnName
LOCAL lcName_str
LOCAL lcClassification
LOCAL lcHandle
LOCAL lcName
LOCAL lnId
LOCAL lcLast_triggered_ts
LOCAL lnOrg_id
LOCAL lcStatus
LOCAL lcV_type
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
LOCAL lcHandle
LOCAL lnPage
LOCAL lnPage_count
LOCAL lnPer_page
LOCAL lnTotal_count
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("query","tempor Ut sed velit")
loQueryParams.UpdateInt("page",0)
loQueryParams.UpdateInt("per_page",30)
loQueryParams.UpdateString("sort","tempor Ut sed velit")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/monitor/search",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lnPage = loJResp.IntOf("metadata.page")
lnPage_count = loJResp.IntOf("metadata.page_count")
lnPer_page = loJResp.IntOf("metadata.per_page")
lnTotal_count = loJResp.IntOf("metadata.total_count")
i = 0
lnCount_i = loJResp.SizeOfArray("counts.muted")
DO WHILE i < lnCount_i
loJResp.I = i
lnCount = loJResp.IntOf("counts.muted[i].count")
lnName = loJResp.BoolOf("counts.muted[i].name")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("counts.status")
DO WHILE i < lnCount_i
loJResp.I = i
lnCount = loJResp.IntOf("counts.status[i].count")
lcName_str = loJResp.StringOf("counts.status[i].name")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("counts.tag")
DO WHILE i < lnCount_i
loJResp.I = i
lnCount = loJResp.IntOf("counts.tag[i].count")
lcName_str = loJResp.StringOf("counts.tag[i].name")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("counts.type")
DO WHILE i < lnCount_i
loJResp.I = i
lnCount = loJResp.IntOf("counts.type[i].count")
lcName_str = loJResp.StringOf("counts.type[i].name")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("monitors")
DO WHILE i < lnCount_i
loJResp.I = i
lcClassification = loJResp.StringOf("monitors[i].classification")
lcHandle = loJResp.StringOf("monitors[i].creator.handle")
lcName = loJResp.StringOf("monitors[i].creator.name")
lnId = loJResp.IntOf("monitors[i].id")
lcLast_triggered_ts = loJResp.StringOf("monitors[i].last_triggered_ts")
lcName_str = loJResp.StringOf("monitors[i].name")
lnOrg_id = loJResp.IntOf("monitors[i].org_id")
lcStatus = loJResp.StringOf("monitors[i].status")
lcV_type = loJResp.StringOf("monitors[i].type")
j = 0
lnCount_j = loJResp.SizeOfArray("monitors[i].metrics")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("monitors[i].metrics[j]")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("monitors[i].notifications")
DO WHILE j < lnCount_j
loJResp.J = j
lcHandle = loJResp.StringOf("monitors[i].notifications[j].handle")
lcName_str = loJResp.StringOf("monitors[i].notifications[j].name")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("monitors[i].scopes")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("monitors[i].scopes[j]")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("monitors[i].tags")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("monitors[i].tags[j]")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
