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,"search","<string>")
CkJsonObject::ckUpdateString(queryParams,"tags","<string>")
CkJsonObject::ckUpdateString(queryParams,"from","<long>")
CkJsonObject::ckUpdateString(queryParams,"to","<long>")
CkJsonObject::ckUpdateInt(queryParams,"page[limit]",1000)
CkJsonObject::ckUpdateString(queryParams,"page[cursor]","<string>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.app.ddog-gov.com/api/v2/processes",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)
; {
; "data": [
; {
; "attributes": {
; "cmdline": "<string>",
; "host": "<string>",
; "pid": "<long>",
; "ppid": "<long>",
; "start": "<string>",
; "tags": [
; "<string>",
; "<string>"
; ],
; "timestamp": "<string>",
; "user": "<string>"
; },
; "id": "<string>",
; "type": "process"
; },
; {
; "attributes": {
; "cmdline": "<string>",
; "host": "<string>",
; "pid": "<long>",
; "ppid": "<long>",
; "start": "<string>",
; "tags": [
; "<string>",
; "<string>"
; ],
; "timestamp": "<string>",
; "user": "<string>"
; },
; "id": "<string>",
; "type": "process"
; }
; ],
; "meta": {
; "page": {
; "after": "<string>",
; "size": "<integer>"
; }
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Cmdline.s
Host.s
Pid.s
Ppid.s
Start.s
Timestamp.s
User.s
id.s
v_type.s
j.i
count_j.i
strVal.s
After.s = CkJsonObject::ckStringOf(jResp,"meta.page.after")
Size.s = CkJsonObject::ckStringOf(jResp,"meta.page.size")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Cmdline = CkJsonObject::ckStringOf(jResp,"data[i].attributes.cmdline")
Host = CkJsonObject::ckStringOf(jResp,"data[i].attributes.host")
Pid = CkJsonObject::ckStringOf(jResp,"data[i].attributes.pid")
Ppid = CkJsonObject::ckStringOf(jResp,"data[i].attributes.ppid")
Start = CkJsonObject::ckStringOf(jResp,"data[i].attributes.start")
Timestamp = CkJsonObject::ckStringOf(jResp,"data[i].attributes.timestamp")
User = CkJsonObject::ckStringOf(jResp,"data[i].attributes.user")
id = CkJsonObject::ckStringOf(jResp,"data[i].id")
v_type = CkJsonObject::ckStringOf(jResp,"data[i].type")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].attributes.tags")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"data[i].attributes.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 "search=%3Cstring%3E"
-d "tags=%3Cstring%3E"
-d "from=%3Clong%3E"
-d "to=%3Clong%3E"
-d "page[limit]=1000"
-d "page[cursor]=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/processes
Postman Collection Item JSON
{
"name": "Get all processes",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
},
"description": "Get all processes for your organization."
},
"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/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"cmdline\": \"<string>\",\n \"host\": \"<string>\",\n \"pid\": \"<long>\",\n \"ppid\": \"<long>\",\n \"start\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"timestamp\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"process\"\n },\n {\n \"attributes\": {\n \"cmdline\": \"<string>\",\n \"host\": \"<string>\",\n \"pid\": \"<long>\",\n \"ppid\": \"<long>\",\n \"start\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"timestamp\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"process\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"after\": \"<string>\",\n \"size\": \"<integer>\"\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/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Authentication Error",
"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/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\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/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
