Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "query" "tempor Ut sed velit"
CkJsonObject_UpdateInt $queryParams "page" 0
CkJsonObject_UpdateInt $queryParams "per_page" 30
CkJsonObject_UpdateString $queryParams "sort" "tempor Ut sed velit"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.app.ddog-gov.com/api/v1/monitor/search" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set Page [CkJsonObject_IntOf $jResp "metadata.page"]
set Page_count [CkJsonObject_IntOf $jResp "metadata.page_count"]
set Per_page [CkJsonObject_IntOf $jResp "metadata.per_page"]
set Total_count [CkJsonObject_IntOf $jResp "metadata.total_count"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "counts.muted"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set count [CkJsonObject_IntOf $jResp "counts.muted[i].count"]
set name [CkJsonObject_BoolOf $jResp "counts.muted[i].name"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "counts.status"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set count [CkJsonObject_IntOf $jResp "counts.status[i].count"]
set name_str [CkJsonObject_stringOf $jResp "counts.status[i].name"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "counts.tag"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set count [CkJsonObject_IntOf $jResp "counts.tag[i].count"]
set name_str [CkJsonObject_stringOf $jResp "counts.tag[i].name"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "counts.type"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set count [CkJsonObject_IntOf $jResp "counts.type[i].count"]
set name_str [CkJsonObject_stringOf $jResp "counts.type[i].name"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "monitors"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set classification [CkJsonObject_stringOf $jResp "monitors[i].classification"]
set Handle [CkJsonObject_stringOf $jResp "monitors[i].creator.handle"]
set Name [CkJsonObject_stringOf $jResp "monitors[i].creator.name"]
set id [CkJsonObject_IntOf $jResp "monitors[i].id"]
set last_triggered_ts [CkJsonObject_stringOf $jResp "monitors[i].last_triggered_ts"]
set name_str [CkJsonObject_stringOf $jResp "monitors[i].name"]
set org_id [CkJsonObject_IntOf $jResp "monitors[i].org_id"]
set status [CkJsonObject_stringOf $jResp "monitors[i].status"]
set v_type [CkJsonObject_stringOf $jResp "monitors[i].type"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "monitors[i].metrics"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "monitors[i].metrics[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "monitors[i].notifications"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set handle [CkJsonObject_stringOf $jResp "monitors[i].notifications[j].handle"]
set name_str [CkJsonObject_stringOf $jResp "monitors[i].notifications[j].name"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "monitors[i].scopes"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "monitors[i].scopes[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "monitors[i].tags"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "monitors[i].tags[j]"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
