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