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