Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
http.SetRequestHeader("Accept","application/json")
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/tests/browser/:public_id",sbResponseBody)
If (success = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(http.LastHeader)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim description As String
Dim strVal As String
Dim day As Integer
Dim from As String
Dim v_to As String
Dim allowFailure As Boolean
Dim isCritical As Boolean
Dim noScreenshot As Boolean
Dim timeout As Integer
Dim Allow_insecure As Boolean = jResp.BoolOf("config.request.allow_insecure")
Dim Password As String = jResp.StringOf("config.request.basicAuth.password")
Dim Username As String = jResp.StringOf("config.request.basicAuth.username")
Dim v_Type As String = jResp.StringOf("config.request.basicAuth.type")
Dim Body As String = jResp.StringOf("config.request.body")
Dim BodyType As String = jResp.StringOf("config.request.bodyType")
Dim CallType As String = jResp.StringOf("config.request.callType")
Dim Content As String = jResp.StringOf("config.request.certificate.cert.content")
Dim Filename As String = jResp.StringOf("config.request.certificate.cert.filename")
Dim UpdatedAt As String = jResp.StringOf("config.request.certificate.cert.updatedAt")
Dim KeyContent As String = jResp.StringOf("config.request.certificate.key.content")
Dim KeyFilename As String = jResp.StringOf("config.request.certificate.key.filename")
Dim KeyUpdatedAt As String = jResp.StringOf("config.request.certificate.key.updatedAt")
Dim CompressedJsonDescriptor As String = jResp.StringOf("config.request.compressedJsonDescriptor")
Dim DnsServer As String = jResp.StringOf("config.request.dnsServer")
Dim DnsServerPort As Integer = jResp.IntOf("config.request.dnsServerPort")
Dim Follow_redirects As Boolean = jResp.BoolOf("config.request.follow_redirects")
Dim Nulla_735 As String = jResp.StringOf("config.request.headers.nulla_735")
Dim Nulla_b_ As String = jResp.StringOf("config.request.headers.nulla_b_")
Dim Host As String = jResp.StringOf("config.request.host")
Dim Message As String = jResp.StringOf("config.request.message")
Dim Eub0d As String = jResp.StringOf("config.request.metadata.eub0d")
Dim Exercitation1 As String = jResp.StringOf("config.request.metadata.exercitation1")
Dim Method As String = jResp.StringOf("config.request.method")
Dim NoSavingResponseBody As Boolean = jResp.BoolOf("config.request.noSavingResponseBody")
Dim NumberOfPackets As Integer = jResp.IntOf("config.request.numberOfPackets")
Dim PersistCookies As Boolean = jResp.BoolOf("config.request.persistCookies")
Dim Port As Integer = jResp.IntOf("config.request.port")
Dim v_Url As String = jResp.StringOf("config.request.proxy.url")
Dim Ipsum83a As String = jResp.StringOf("config.request.proxy.headers.ipsum83a")
Dim Irure_8 As String = jResp.StringOf("config.request.proxy.headers.irure_8")
Dim Esse67f As String = jResp.StringOf("config.request.proxy.headers.esse67f")
Dim Servername As String = jResp.StringOf("config.request.servername")
Dim Service As String = jResp.StringOf("config.request.service")
Dim ShouldTrackHops As Boolean = jResp.BoolOf("config.request.shouldTrackHops")
Dim Timeout As String = jResp.StringOf("config.request.timeout")
Dim RequestUrl As String = jResp.StringOf("config.request.url")
Dim SetCookie As String = jResp.StringOf("config.setCookie")
Dim name As String = jResp.StringOf("name")
Dim Accept_self_signed As Boolean = jResp.BoolOf("options.accept_self_signed")
Dim optionsAllow_insecure As Boolean = jResp.BoolOf("options.allow_insecure")
Dim CheckCertificateRevocation As Boolean = jResp.BoolOf("options.checkCertificateRevocation")
Dim ExecutionRule As String = jResp.StringOf("options.ci.executionRule")
Dim DisableCors As Boolean = jResp.BoolOf("options.disableCors")
Dim DisableCsp As Boolean = jResp.BoolOf("options.disableCsp")
Dim optionsFollow_redirects As Boolean = jResp.BoolOf("options.follow_redirects")
Dim HttpVersion As String = jResp.StringOf("options.httpVersion")
Dim IgnoreServerCertificateError As Boolean = jResp.BoolOf("options.ignoreServerCertificateError")
Dim InitialNavigationTimeout As Integer = jResp.IntOf("options.initialNavigationTimeout")
Dim Min_failure_duration As Integer = jResp.IntOf("options.min_failure_duration")
Dim Min_location_failed As Integer = jResp.IntOf("options.min_location_failed")
Dim Monitor_name As String = jResp.StringOf("options.monitor_name")
Dim Renotify_interval As Integer = jResp.IntOf("options.monitor_options.renotify_interval")
Dim Monitor_priority As Integer = jResp.IntOf("options.monitor_priority")
Dim NoScreenshot As Boolean = jResp.BoolOf("options.noScreenshot")
Dim Count As Integer = jResp.IntOf("options.retry.count")
Dim Interval As String = jResp.StringOf("options.retry.interval")
Dim ApplicationId As String = jResp.StringOf("options.rumSettings.applicationId")
Dim ClientTokenId As Integer = jResp.IntOf("options.rumSettings.clientTokenId")
Dim IsEnabled As Boolean = jResp.BoolOf("options.rumSettings.isEnabled")
Dim Timezone As String = jResp.StringOf("options.scheduling.timezone")
Dim Tick_every As Integer = jResp.IntOf("options.tick_every")
Dim v_type As String = jResp.StringOf("type")
Dim message As String = jResp.StringOf("message")
Dim monitor_id As Integer = jResp.IntOf("monitor_id")
Dim public_id As String = jResp.StringOf("public_id")
Dim status As String = jResp.StringOf("status")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("config.configVariables")
While i < count_i
jResp.I = i
description = jResp.StringOf("config.configVariables[i].description")
v_type = jResp.StringOf("config.configVariables[i].type")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("config.variables")
While i < count_i
jResp.I = i
description = jResp.StringOf("config.variables[i].description")
v_type = jResp.StringOf("config.variables[i].type")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("locations")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("locations[i]")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("options.device_ids")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("options.device_ids[i]")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("options.restricted_roles")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("options.restricted_roles[i]")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("options.scheduling.timeframes")
While i < count_i
jResp.I = i
day = jResp.IntOf("options.scheduling.timeframes[i].day")
from = jResp.StringOf("options.scheduling.timeframes[i].from")
v_to = jResp.StringOf("options.scheduling.timeframes[i].to")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("steps")
While i < count_i
jResp.I = i
allowFailure = jResp.BoolOf("steps[i].allowFailure")
isCritical = jResp.BoolOf("steps[i].isCritical")
name = jResp.StringOf("steps[i].name")
noScreenshot = jResp.BoolOf("steps[i].noScreenshot")
timeout = jResp.IntOf("steps[i].timeout")
v_type = jResp.StringOf("steps[i].type")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("tags")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("tags[i]")
i = i + 1
End While
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}"
}
]
}
