Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.app.ddog-gov.com/api/v1/synthetics/tests/api/:public_id",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "name": "Example test name",
; "config": {
; "assertions": [
; {
; "operator": "lessThan",
; "target": 1000,
; "type": "responseTime"
; }
; ],
; "request": {
; "method": "GET",
; "url": "https://example.com"
; }
; },
; "locations": [
; "aws:eu-west-3"
; ],
; "options": {
; "accept_self_signed": true,
; "allow_insecure": true,
; "checkCertificateRevocation": true,
; "ci": {
; "executionRule": "non_blocking"
; },
; "device_ids": [
; "laptop_large",
; "laptop_large"
; ],
; "disableCors": false,
; "disableCsp": false,
; "follow_redirects": true,
; "httpVersion": "http1",
; "ignoreServerCertificateError": false,
; "initialNavigationTimeout": 87780679,
; "min_failure_duration": -32472759,
; "min_location_failed": -5806955,
; "monitor_name": "et deserunt ",
; "monitor_options": {
; "renotify_interval": 834
; },
; "monitor_priority": 3,
; "noScreenshot": false,
; "restricted_roles": [
; "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
; ],
; "retry": {
; "count": -50657150,
; "interval": -91565669.0691471
; },
; "rumSettings": {
; "applicationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
; "clientTokenId": 12345,
; "isEnabled": true
; },
; "scheduling": {
; "timeframes": [
; {
; "day": 1,
; "from": "07:00",
; "to": "16:00"
; },
; {
; "day": 3,
; "from": "07:00",
; "to": "16:00"
; }
; ],
; "timezone": "America/New_York"
; },
; "tick_every": 384020
; },
; "type": "api",
; "message": "Notification message",
; "monitor_id": 12345678,
; "public_id": "123-abc-456",
; "status": "live",
; "subtype": "http",
; "tags": [
; "env:production"
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
operator.s
target.i
strVal.s
day.i
from.s
v_to.s
name.s = CkJsonObject::ckStringOf(jResp,"name")
Method.s = CkJsonObject::ckStringOf(jResp,"config.request.method")
v_Url.s = CkJsonObject::ckStringOf(jResp,"config.request.url")
Accept_self_signed.i = CkJsonObject::ckBoolOf(jResp,"options.accept_self_signed")
Allow_insecure.i = CkJsonObject::ckBoolOf(jResp,"options.allow_insecure")
CheckCertificateRevocation.i = CkJsonObject::ckBoolOf(jResp,"options.checkCertificateRevocation")
ExecutionRule.s = CkJsonObject::ckStringOf(jResp,"options.ci.executionRule")
DisableCors.i = CkJsonObject::ckBoolOf(jResp,"options.disableCors")
DisableCsp.i = CkJsonObject::ckBoolOf(jResp,"options.disableCsp")
Follow_redirects.i = CkJsonObject::ckBoolOf(jResp,"options.follow_redirects")
HttpVersion.s = CkJsonObject::ckStringOf(jResp,"options.httpVersion")
IgnoreServerCertificateError.i = CkJsonObject::ckBoolOf(jResp,"options.ignoreServerCertificateError")
InitialNavigationTimeout.i = CkJsonObject::ckIntOf(jResp,"options.initialNavigationTimeout")
Min_failure_duration.i = CkJsonObject::ckIntOf(jResp,"options.min_failure_duration")
Min_location_failed.i = CkJsonObject::ckIntOf(jResp,"options.min_location_failed")
Monitor_name.s = CkJsonObject::ckStringOf(jResp,"options.monitor_name")
Renotify_interval.i = CkJsonObject::ckIntOf(jResp,"options.monitor_options.renotify_interval")
Monitor_priority.i = CkJsonObject::ckIntOf(jResp,"options.monitor_priority")
NoScreenshot.i = CkJsonObject::ckBoolOf(jResp,"options.noScreenshot")
Count.i = CkJsonObject::ckIntOf(jResp,"options.retry.count")
Interval.s = CkJsonObject::ckStringOf(jResp,"options.retry.interval")
ApplicationId.s = CkJsonObject::ckStringOf(jResp,"options.rumSettings.applicationId")
ClientTokenId.i = CkJsonObject::ckIntOf(jResp,"options.rumSettings.clientTokenId")
IsEnabled.i = CkJsonObject::ckBoolOf(jResp,"options.rumSettings.isEnabled")
Timezone.s = CkJsonObject::ckStringOf(jResp,"options.scheduling.timezone")
Tick_every.i = CkJsonObject::ckIntOf(jResp,"options.tick_every")
v_type.s = CkJsonObject::ckStringOf(jResp,"type")
message.s = CkJsonObject::ckStringOf(jResp,"message")
monitor_id.i = CkJsonObject::ckIntOf(jResp,"monitor_id")
public_id.s = CkJsonObject::ckStringOf(jResp,"public_id")
status.s = CkJsonObject::ckStringOf(jResp,"status")
subtype.s = CkJsonObject::ckStringOf(jResp,"subtype")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"config.assertions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
operator = CkJsonObject::ckStringOf(jResp,"config.assertions[i].operator")
target = CkJsonObject::ckIntOf(jResp,"config.assertions[i].target")
v_type = CkJsonObject::ckStringOf(jResp,"config.assertions[i].type")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"locations")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"locations[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"options.device_ids")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"options.device_ids[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"options.restricted_roles")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"options.restricted_roles[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"options.scheduling.timeframes")
While i < count_i
CkJsonObject::setCkI(jResp, i)
day = CkJsonObject::ckIntOf(jResp,"options.scheduling.timeframes[i].day")
from = CkJsonObject::ckStringOf(jResp,"options.scheduling.timeframes[i].from")
v_to = CkJsonObject::ckStringOf(jResp,"options.scheduling.timeframes[i].to")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"tags[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/tests/api/:public_id
Postman Collection Item JSON
{
"name": "Get an API test",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "tempor Ut sed velit"
}
]
},
"description": "Get the detailed configuration associated with\na Synthetic API test."
},
"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/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"name\": \"Example test name\",\n \"config\": {\n \"assertions\": [\n {\n \"operator\": \"lessThan\",\n \"target\": 1000,\n \"type\": \"responseTime\"\n }\n ],\n \"request\": {\n \"method\": \"GET\",\n \"url\": \"https://example.com\"\n }\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": true,\n \"checkCertificateRevocation\": true,\n \"ci\": {\n \"executionRule\": \"non_blocking\"\n },\n \"device_ids\": [\n \"laptop_large\",\n \"laptop_large\"\n ],\n \"disableCors\": false,\n \"disableCsp\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http1\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": 87780679,\n \"min_failure_duration\": -32472759,\n \"min_location_failed\": -5806955,\n \"monitor_name\": \"et deserunt \",\n \"monitor_options\": {\n \"renotify_interval\": 834\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": -50657150,\n \"interval\": -91565669.0691471\n },\n \"rumSettings\": {\n \"applicationId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"clientTokenId\": 12345,\n \"isEnabled\": true\n },\n \"scheduling\": {\n \"timeframes\": [\n {\n \"day\": 1,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n },\n {\n \"day\": 3,\n \"from\": \"07:00\",\n \"to\": \"16:00\"\n }\n ],\n \"timezone\": \"America/New_York\"\n },\n \"tick_every\": 384020\n },\n \"type\": \"api\",\n \"message\": \"Notification message\",\n \"monitor_id\": 12345678,\n \"public_id\": \"123-abc-456\",\n \"status\": \"live\",\n \"subtype\": \"http\",\n \"tags\": [\n \"env:production\"\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/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"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": "- Synthetic Monitoring is not activated for the user\n- Test is not owned by the user",
"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/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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/synthetics/tests/api/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"api",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"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}"
}
]
}
