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/ci/batch/:batch_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)
// {
// "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
string device;
string duration;
string execution_rule;
string location;
string result_id;
string retries;
string status;
string test_name;
string test_public_id;
string test_type;
string v_Url = jResp.StringOf("data.metadata.ci.pipeline.url");
string Name = jResp.StringOf("data.metadata.ci.provider.name");
string Branch = jResp.StringOf("data.metadata.git.branch");
string CommitSha = jResp.StringOf("data.metadata.git.commitSha");
string Status = jResp.StringOf("data.status");
int i = 0;
int count_i = jResp.SizeOfArray("data.results");
while (i < count_i) {
jResp.I = i;
device = jResp.StringOf("data.results[i].device");
duration = jResp.StringOf("data.results[i].duration");
execution_rule = jResp.StringOf("data.results[i].execution_rule");
location = jResp.StringOf("data.results[i].location");
result_id = jResp.StringOf("data.results[i].result_id");
retries = jResp.StringOf("data.results[i].retries");
status = jResp.StringOf("data.results[i].status");
test_name = jResp.StringOf("data.results[i].test_name");
test_public_id = jResp.StringOf("data.results[i].test_public_id");
test_type = jResp.StringOf("data.results[i].test_type");
i = i + 1;
}
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}"
}
]
}
