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]
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api.app.ddog-gov.com/api/v1/synthetics/tests/browser/:public_id" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "config": {
# "request": {
# "allow_insecure": false,
# "basicAuth": {
# "password": "PaSSw0RD!",
# "username": "my_username",
# "type": "web"
# },
# "body": "dolore",
# "bodyType": "text/plain",
# "callType": "unary",
# "certificate": {
# "cert": {
# "content": "dolor mollit id eu",
# "filename": "enim ",
# "updatedAt": "ad labore d"
# },
# "key": {
# "content": "anim ut consequat eiusmod",
# "filename": "non consectetur voluptate",
# "updatedAt": "proi"
# }
# },
# "compressedJsonDescriptor": "velit cillum",
# "dnsServer": "sint irure sit commodo",
# "dnsServerPort": 63263,
# "follow_redirects": true,
# "headers": {
# "nulla_735": "esse enim velit",
# "nulla_b_": "laboris ut"
# },
# "host": "aliquip nostrud",
# "message": "Lorem laboris",
# "metadata": {
# "eub0d": "sint",
# "exercitation1": "ut Duis"
# },
# "method": "dolo",
# "noSavingResponseBody": false,
# "numberOfPackets": 1,
# "persistCookies": true,
# "port": 82704033,
# "proxy": {
# "url": "https://example.com",
# "headers": {
# "ipsum83a": "ea laborum",
# "irure_8": "dolor eiusmod aliqua ",
# "esse67f": "veniam qui in"
# }
# },
# "query": {},
# "servername": "Duis sed minim quis",
# "service": "Greeter",
# "shouldTrackHops": false,
# "timeout": 48414705.45711616,
# "url": "https://example.com"
# },
# "configVariables": [
# {
# "description": "Example for the variable.",
# "type": "string"
# },
# {
# "description": "Example for the variable.",
# "type": "string"
# }
# ],
# "setCookie": "anim",
# "variables": [
# {
# "description": "Example for the variable.",
# "type": "string"
# },
# {
# "description": "Example for the variable.",
# "type": "string"
# }
# ]
# },
# "locations": [
# "aws:eu-west-3"
# ],
# "name": "Example test name",
# "options": {
# "accept_self_signed": true,
# "allow_insecure": false,
# "checkCertificateRevocation": false,
# "ci": {
# "executionRule": "skipped"
# },
# "device_ids": [
# "laptop_large",
# "laptop_large"
# ],
# "disableCors": true,
# "disableCsp": false,
# "follow_redirects": true,
# "httpVersion": "http2",
# "ignoreServerCertificateError": false,
# "initialNavigationTimeout": -93160400,
# "min_failure_duration": 9338007,
# "min_location_failed": -22553383,
# "monitor_name": "nostrud dolor ullamco",
# "monitor_options": {
# "renotify_interval": 261
# },
# "monitor_priority": 3,
# "noScreenshot": false,
# "restricted_roles": [
# "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# ],
# "retry": {
# "count": 67368482,
# "interval": 59042710.53770983
# },
# "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": 427884
# },
# "type": "browser",
# "message": "",
# "monitor_id": -23388126,
# "public_id": "cupidatat ipsum",
# "status": "live",
# "steps": [
# {
# "allowFailure": false,
# "isCritical": true,
# "name": "proident dolore ex",
# "noScreenshot": true,
# "params": {},
# "timeout": 70509439,
# "type": "assertElementContent"
# },
# {
# "allowFailure": true,
# "isCritical": true,
# "name": "adipisicing volupt",
# "noScreenshot": false,
# "params": {},
# "timeout": -22942790,
# "type": "assertElementContent"
# }
# ],
# "tags": [
# "env:prod"
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Allow_insecure [CkJsonObject_BoolOf $jResp "config.request.allow_insecure"]
set Password [CkJsonObject_stringOf $jResp "config.request.basicAuth.password"]
set Username [CkJsonObject_stringOf $jResp "config.request.basicAuth.username"]
set v_Type [CkJsonObject_stringOf $jResp "config.request.basicAuth.type"]
set Body [CkJsonObject_stringOf $jResp "config.request.body"]
set BodyType [CkJsonObject_stringOf $jResp "config.request.bodyType"]
set CallType [CkJsonObject_stringOf $jResp "config.request.callType"]
set Content [CkJsonObject_stringOf $jResp "config.request.certificate.cert.content"]
set Filename [CkJsonObject_stringOf $jResp "config.request.certificate.cert.filename"]
set UpdatedAt [CkJsonObject_stringOf $jResp "config.request.certificate.cert.updatedAt"]
set KeyContent [CkJsonObject_stringOf $jResp "config.request.certificate.key.content"]
set KeyFilename [CkJsonObject_stringOf $jResp "config.request.certificate.key.filename"]
set KeyUpdatedAt [CkJsonObject_stringOf $jResp "config.request.certificate.key.updatedAt"]
set CompressedJsonDescriptor [CkJsonObject_stringOf $jResp "config.request.compressedJsonDescriptor"]
set DnsServer [CkJsonObject_stringOf $jResp "config.request.dnsServer"]
set DnsServerPort [CkJsonObject_IntOf $jResp "config.request.dnsServerPort"]
set Follow_redirects [CkJsonObject_BoolOf $jResp "config.request.follow_redirects"]
set Nulla_735 [CkJsonObject_stringOf $jResp "config.request.headers.nulla_735"]
set Nulla_b_ [CkJsonObject_stringOf $jResp "config.request.headers.nulla_b_"]
set Host [CkJsonObject_stringOf $jResp "config.request.host"]
set Message [CkJsonObject_stringOf $jResp "config.request.message"]
set Eub0d [CkJsonObject_stringOf $jResp "config.request.metadata.eub0d"]
set Exercitation1 [CkJsonObject_stringOf $jResp "config.request.metadata.exercitation1"]
set Method [CkJsonObject_stringOf $jResp "config.request.method"]
set NoSavingResponseBody [CkJsonObject_BoolOf $jResp "config.request.noSavingResponseBody"]
set NumberOfPackets [CkJsonObject_IntOf $jResp "config.request.numberOfPackets"]
set PersistCookies [CkJsonObject_BoolOf $jResp "config.request.persistCookies"]
set Port [CkJsonObject_IntOf $jResp "config.request.port"]
set v_Url [CkJsonObject_stringOf $jResp "config.request.proxy.url"]
set Ipsum83a [CkJsonObject_stringOf $jResp "config.request.proxy.headers.ipsum83a"]
set Irure_8 [CkJsonObject_stringOf $jResp "config.request.proxy.headers.irure_8"]
set Esse67f [CkJsonObject_stringOf $jResp "config.request.proxy.headers.esse67f"]
set Servername [CkJsonObject_stringOf $jResp "config.request.servername"]
set Service [CkJsonObject_stringOf $jResp "config.request.service"]
set ShouldTrackHops [CkJsonObject_BoolOf $jResp "config.request.shouldTrackHops"]
set Timeout [CkJsonObject_stringOf $jResp "config.request.timeout"]
set RequestUrl [CkJsonObject_stringOf $jResp "config.request.url"]
set SetCookie [CkJsonObject_stringOf $jResp "config.setCookie"]
set name [CkJsonObject_stringOf $jResp "name"]
set Accept_self_signed [CkJsonObject_BoolOf $jResp "options.accept_self_signed"]
set optionsAllow_insecure [CkJsonObject_BoolOf $jResp "options.allow_insecure"]
set CheckCertificateRevocation [CkJsonObject_BoolOf $jResp "options.checkCertificateRevocation"]
set ExecutionRule [CkJsonObject_stringOf $jResp "options.ci.executionRule"]
set DisableCors [CkJsonObject_BoolOf $jResp "options.disableCors"]
set DisableCsp [CkJsonObject_BoolOf $jResp "options.disableCsp"]
set optionsFollow_redirects [CkJsonObject_BoolOf $jResp "options.follow_redirects"]
set HttpVersion [CkJsonObject_stringOf $jResp "options.httpVersion"]
set IgnoreServerCertificateError [CkJsonObject_BoolOf $jResp "options.ignoreServerCertificateError"]
set InitialNavigationTimeout [CkJsonObject_IntOf $jResp "options.initialNavigationTimeout"]
set Min_failure_duration [CkJsonObject_IntOf $jResp "options.min_failure_duration"]
set Min_location_failed [CkJsonObject_IntOf $jResp "options.min_location_failed"]
set Monitor_name [CkJsonObject_stringOf $jResp "options.monitor_name"]
set Renotify_interval [CkJsonObject_IntOf $jResp "options.monitor_options.renotify_interval"]
set Monitor_priority [CkJsonObject_IntOf $jResp "options.monitor_priority"]
set NoScreenshot [CkJsonObject_BoolOf $jResp "options.noScreenshot"]
set Count [CkJsonObject_IntOf $jResp "options.retry.count"]
set Interval [CkJsonObject_stringOf $jResp "options.retry.interval"]
set ApplicationId [CkJsonObject_stringOf $jResp "options.rumSettings.applicationId"]
set ClientTokenId [CkJsonObject_IntOf $jResp "options.rumSettings.clientTokenId"]
set IsEnabled [CkJsonObject_BoolOf $jResp "options.rumSettings.isEnabled"]
set Timezone [CkJsonObject_stringOf $jResp "options.scheduling.timezone"]
set Tick_every [CkJsonObject_IntOf $jResp "options.tick_every"]
set v_type [CkJsonObject_stringOf $jResp "type"]
set message [CkJsonObject_stringOf $jResp "message"]
set monitor_id [CkJsonObject_IntOf $jResp "monitor_id"]
set public_id [CkJsonObject_stringOf $jResp "public_id"]
set status [CkJsonObject_stringOf $jResp "status"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "config.configVariables"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set description [CkJsonObject_stringOf $jResp "config.configVariables[i].description"]
set v_type [CkJsonObject_stringOf $jResp "config.configVariables[i].type"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "config.variables"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set description [CkJsonObject_stringOf $jResp "config.variables[i].description"]
set v_type [CkJsonObject_stringOf $jResp "config.variables[i].type"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "locations"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "locations[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "options.device_ids"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "options.device_ids[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "options.restricted_roles"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "options.restricted_roles[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "options.scheduling.timeframes"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set day [CkJsonObject_IntOf $jResp "options.scheduling.timeframes[i].day"]
set from [CkJsonObject_stringOf $jResp "options.scheduling.timeframes[i].from"]
set v_to [CkJsonObject_stringOf $jResp "options.scheduling.timeframes[i].to"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "steps"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set allowFailure [CkJsonObject_BoolOf $jResp "steps[i].allowFailure"]
set isCritical [CkJsonObject_BoolOf $jResp "steps[i].isCritical"]
set name [CkJsonObject_stringOf $jResp "steps[i].name"]
set noScreenshot [CkJsonObject_BoolOf $jResp "steps[i].noScreenshot"]
set timeout [CkJsonObject_IntOf $jResp "steps[i].timeout"]
set v_type [CkJsonObject_stringOf $jResp "steps[i].type"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "tags"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "tags[i]"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/tests/browser/:public_id
Postman Collection Item JSON
{
"name": "Get a browser test",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id",
"value": "tempor Ut sed velit"
}
]
},
"description": "Get the detailed configuration (including steps) associated with\na Synthetic browser 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/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":public_id"
],
"variable": [
{
"key": "public_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"config\": {\n \"request\": {\n \"allow_insecure\": false,\n \"basicAuth\": {\n \"password\": \"PaSSw0RD!\",\n \"username\": \"my_username\",\n \"type\": \"web\"\n },\n \"body\": \"dolore\",\n \"bodyType\": \"text/plain\",\n \"callType\": \"unary\",\n \"certificate\": {\n \"cert\": {\n \"content\": \"dolor mollit id eu\",\n \"filename\": \"enim \",\n \"updatedAt\": \"ad labore d\"\n },\n \"key\": {\n \"content\": \"anim ut consequat eiusmod\",\n \"filename\": \"non consectetur voluptate\",\n \"updatedAt\": \"proi\"\n }\n },\n \"compressedJsonDescriptor\": \"velit cillum\",\n \"dnsServer\": \"sint irure sit commodo\",\n \"dnsServerPort\": 63263,\n \"follow_redirects\": true,\n \"headers\": {\n \"nulla_735\": \"esse enim velit\",\n \"nulla_b_\": \"laboris ut\"\n },\n \"host\": \"aliquip nostrud\",\n \"message\": \"Lorem laboris\",\n \"metadata\": {\n \"eub0d\": \"sint\",\n \"exercitation1\": \"ut Duis\"\n },\n \"method\": \"dolo\",\n \"noSavingResponseBody\": false,\n \"numberOfPackets\": 1,\n \"persistCookies\": true,\n \"port\": 82704033,\n \"proxy\": {\n \"url\": \"https://example.com\",\n \"headers\": {\n \"ipsum83a\": \"ea laborum\",\n \"irure_8\": \"dolor eiusmod aliqua \",\n \"esse67f\": \"veniam qui in\"\n }\n },\n \"query\": {},\n \"servername\": \"Duis sed minim quis\",\n \"service\": \"Greeter\",\n \"shouldTrackHops\": false,\n \"timeout\": 48414705.45711616,\n \"url\": \"https://example.com\"\n },\n \"configVariables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ],\n \"setCookie\": \"anim\",\n \"variables\": [\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Example for the variable.\",\n \"type\": \"string\"\n }\n ]\n },\n \"locations\": [\n \"aws:eu-west-3\"\n ],\n \"name\": \"Example test name\",\n \"options\": {\n \"accept_self_signed\": true,\n \"allow_insecure\": false,\n \"checkCertificateRevocation\": false,\n \"ci\": {\n \"executionRule\": \"skipped\"\n },\n \"device_ids\": [\n \"laptop_large\",\n \"laptop_large\"\n ],\n \"disableCors\": true,\n \"disableCsp\": false,\n \"follow_redirects\": true,\n \"httpVersion\": \"http2\",\n \"ignoreServerCertificateError\": false,\n \"initialNavigationTimeout\": -93160400,\n \"min_failure_duration\": 9338007,\n \"min_location_failed\": -22553383,\n \"monitor_name\": \"nostrud dolor ullamco\",\n \"monitor_options\": {\n \"renotify_interval\": 261\n },\n \"monitor_priority\": 3,\n \"noScreenshot\": false,\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ],\n \"retry\": {\n \"count\": 67368482,\n \"interval\": 59042710.53770983\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\": 427884\n },\n \"type\": \"browser\",\n \"message\": \"\",\n \"monitor_id\": -23388126,\n \"public_id\": \"cupidatat ipsum\",\n \"status\": \"live\",\n \"steps\": [\n {\n \"allowFailure\": false,\n \"isCritical\": true,\n \"name\": \"proident dolore ex\",\n \"noScreenshot\": true,\n \"params\": {},\n \"timeout\": 70509439,\n \"type\": \"assertElementContent\"\n },\n {\n \"allowFailure\": true,\n \"isCritical\": true,\n \"name\": \"adipisicing volupt\",\n \"noScreenshot\": false,\n \"params\": {},\n \"timeout\": -22942790,\n \"type\": \"assertElementContent\"\n }\n ],\n \"tags\": [\n \"env:prod\"\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/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":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/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":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/browser/:public_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"browser",
":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}"
}
]
}
