Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"query","tempor Ut sed velit")
CkJsonObject::ckUpdateInt(queryParams,"page",0)
CkJsonObject::ckUpdateInt(queryParams,"per_page",30)
CkJsonObject::ckUpdateString(queryParams,"sort","tempor Ut sed velit")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.app.ddog-gov.com/api/v1/monitor/search",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
count.i
name.i
name_str.s
classification.s
Handle.s
Name.s
id.i
last_triggered_ts.s
org_id.i
status.s
v_type.s
j.i
count_j.i
strVal.s
handle.s
Page.i = CkJsonObject::ckIntOf(jResp,"metadata.page")
Page_count.i = CkJsonObject::ckIntOf(jResp,"metadata.page_count")
Per_page.i = CkJsonObject::ckIntOf(jResp,"metadata.per_page")
Total_count.i = CkJsonObject::ckIntOf(jResp,"metadata.total_count")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"counts.muted")
While i < count_i
CkJsonObject::setCkI(jResp, i)
count = CkJsonObject::ckIntOf(jResp,"counts.muted[i].count")
name = CkJsonObject::ckBoolOf(jResp,"counts.muted[i].name")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"counts.status")
While i < count_i
CkJsonObject::setCkI(jResp, i)
count = CkJsonObject::ckIntOf(jResp,"counts.status[i].count")
name_str = CkJsonObject::ckStringOf(jResp,"counts.status[i].name")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"counts.tag")
While i < count_i
CkJsonObject::setCkI(jResp, i)
count = CkJsonObject::ckIntOf(jResp,"counts.tag[i].count")
name_str = CkJsonObject::ckStringOf(jResp,"counts.tag[i].name")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"counts.type")
While i < count_i
CkJsonObject::setCkI(jResp, i)
count = CkJsonObject::ckIntOf(jResp,"counts.type[i].count")
name_str = CkJsonObject::ckStringOf(jResp,"counts.type[i].name")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"monitors")
While i < count_i
CkJsonObject::setCkI(jResp, i)
classification = CkJsonObject::ckStringOf(jResp,"monitors[i].classification")
Handle = CkJsonObject::ckStringOf(jResp,"monitors[i].creator.handle")
Name = CkJsonObject::ckStringOf(jResp,"monitors[i].creator.name")
id = CkJsonObject::ckIntOf(jResp,"monitors[i].id")
last_triggered_ts = CkJsonObject::ckStringOf(jResp,"monitors[i].last_triggered_ts")
name_str = CkJsonObject::ckStringOf(jResp,"monitors[i].name")
org_id = CkJsonObject::ckIntOf(jResp,"monitors[i].org_id")
status = CkJsonObject::ckStringOf(jResp,"monitors[i].status")
v_type = CkJsonObject::ckStringOf(jResp,"monitors[i].type")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"monitors[i].metrics")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"monitors[i].metrics[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"monitors[i].notifications")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
handle = CkJsonObject::ckStringOf(jResp,"monitors[i].notifications[j].handle")
name_str = CkJsonObject::ckStringOf(jResp,"monitors[i].notifications[j].name")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"monitors[i].scopes")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"monitors[i].scopes[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"monitors[i].tags")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"monitors[i].tags[j]")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
