Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/ci/batch/:batch_id",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "metadata": {
; "ci": {
; "pipeline": {
; "url": "dolor irure amet aliqua"
; },
; "provider": {
; "name": "velit voluptate minim tempor et"
; }
; },
; "git": {
; "branch": "proident pariatur cillum ipsum",
; "commitSha": "no"
; }
; },
; "results": [
; {
; "device": "laptop_large",
; "duration": 77555392.34670219,
; "execution_rule": "blocking",
; "location": "nostrud consectetur proident elit",
; "result_id": "ad in",
; "retries": 27165346.602910966,
; "status": "passed",
; "test_name": "in Excepteur",
; "test_public_id": "aute sint",
; "test_type": "browser"
; },
; {
; "device": "laptop_large",
; "duration": -71572766.6529502,
; "execution_rule": "non_blocking",
; "location": "velit ullamco",
; "result_id": "quis irure officia Lorem enim",
; "retries": 66253781.442619294,
; "status": "passed",
; "test_name": "reprehenderit voluptate incididu",
; "test_public_id": "ipsum Duis",
; "test_type": "api"
; }
; ],
; "status": "passed"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sDevice
Local $sDuration
Local $sExecution_rule
Local $sLocation
Local $sResult_id
Local $sRetries
Local $status
Local $sTest_name
Local $sTest_public_id
Local $sTest_type
Local $sV_Url = $oJResp.StringOf("data.metadata.ci.pipeline.url")
Local $sName = $oJResp.StringOf("data.metadata.ci.provider.name")
Local $sBranch = $oJResp.StringOf("data.metadata.git.branch")
Local $sCommitSha = $oJResp.StringOf("data.metadata.git.commitSha")
Local $sStatus = $oJResp.StringOf("data.status")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.results")
While $i < $iCount_i
$oJResp.I = $i
$sDevice = $oJResp.StringOf("data.results[i].device")
$sDuration = $oJResp.StringOf("data.results[i].duration")
$sExecution_rule = $oJResp.StringOf("data.results[i].execution_rule")
$sLocation = $oJResp.StringOf("data.results[i].location")
$sResult_id = $oJResp.StringOf("data.results[i].result_id")
$sRetries = $oJResp.StringOf("data.results[i].retries")
$status = $oJResp.StringOf("data.results[i].status")
$sTest_name = $oJResp.StringOf("data.results[i].test_name")
$sTest_public_id = $oJResp.StringOf("data.results[i].test_public_id")
$sTest_type = $oJResp.StringOf("data.results[i].test_type")
$i = $i + 1
Wend
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/ci/batch/:batch_id
Postman Collection Item JSON
{
"name": "Get details of batch",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/ci/batch/:batch_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"ci",
"batch",
":batch_id"
],
"variable": [
{
"key": "batch_id",
"value": "tempor Ut sed velit"
}
]
},
"description": "Get a batch's updated details."
},
"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/ci/batch/:batch_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"ci",
"batch",
":batch_id"
],
"variable": [
{
"key": "batch_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"dolor irure amet aliqua\"\n },\n \"provider\": {\n \"name\": \"velit voluptate minim tempor et\"\n }\n },\n \"git\": {\n \"branch\": \"proident pariatur cillum ipsum\",\n \"commitSha\": \"no\"\n }\n },\n \"results\": [\n {\n \"device\": \"laptop_large\",\n \"duration\": 77555392.34670219,\n \"execution_rule\": \"blocking\",\n \"location\": \"nostrud consectetur proident elit\",\n \"result_id\": \"ad in\",\n \"retries\": 27165346.602910966,\n \"status\": \"passed\",\n \"test_name\": \"in Excepteur\",\n \"test_public_id\": \"aute sint\",\n \"test_type\": \"browser\"\n },\n {\n \"device\": \"laptop_large\",\n \"duration\": -71572766.6529502,\n \"execution_rule\": \"non_blocking\",\n \"location\": \"velit ullamco\",\n \"result_id\": \"quis irure officia Lorem enim\",\n \"retries\": 66253781.442619294,\n \"status\": \"passed\",\n \"test_name\": \"reprehenderit voluptate incididu\",\n \"test_public_id\": \"ipsum Duis\",\n \"test_type\": \"api\"\n }\n ],\n \"status\": \"passed\"\n }\n}"
},
{
"name": "Batch does not exist.",
"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/ci/batch/:batch_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"ci",
"batch",
":batch_id"
],
"variable": [
{
"key": "batch_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/ci/batch/:batch_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"ci",
"batch",
":batch_id"
],
"variable": [
{
"key": "batch_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}"
}
]
}
