Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Description: PWideChar;
Qui72Description: PWideChar;
Dolore4: PWideChar;
Proident9aDescription: PWideChar;
Lorem62: PWideChar;
Ut5: PWideChar;
code: PWideChar;
detail: PWideChar;
title: PWideChar;
v_Next: PWideChar;
Elapsed: PWideChar;
Request_id: PWideChar;
Status: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "compute": [
// {
// "aggregation": "pc95",
// "interval": "<string>",
// "metric": "<string>",
// "type": "total"
// },
// {
// "aggregation": "avg",
// "interval": "<string>",
// "metric": "<string>",
// "type": "total"
// }
// ],
// "filter": {
// "from": "now-15m",
// "query": "*",
// "to": "now"
// },
// "group_by": [
// {
// "facet": "<string>",
// "histogram": {
// "interval": "<double>",
// "min": "<double>",
// "max": "<double>"
// },
// "limit": 10,
// "missing": "<string>",
// "sort": {
// "aggregation": "delta",
// "metric": "<string>",
// "order": "asc",
// "type": "alphabetical"
// },
// "total": "<boolean>"
// },
// {
// "facet": "<string>",
// "histogram": {
// "interval": "<double>",
// "min": "<double>",
// "max": "<double>"
// },
// "limit": 10,
// "missing": "<string>",
// "sort": {
// "aggregation": "pc99",
// "metric": "<string>",
// "order": "desc",
// "type": "alphabetical"
// },
// "total": "<boolean>"
// }
// ],
// "options": {
// "time_offset": "<long>",
// "timezone": "UTC"
// }
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'compute[0].aggregation','pc95');
CkJsonObject_UpdateString(json,'compute[0].interval','<string>');
CkJsonObject_UpdateString(json,'compute[0].metric','<string>');
CkJsonObject_UpdateString(json,'compute[0].type','total');
CkJsonObject_UpdateString(json,'compute[1].aggregation','avg');
CkJsonObject_UpdateString(json,'compute[1].interval','<string>');
CkJsonObject_UpdateString(json,'compute[1].metric','<string>');
CkJsonObject_UpdateString(json,'compute[1].type','total');
CkJsonObject_UpdateString(json,'filter.from','now-15m');
CkJsonObject_UpdateString(json,'filter.query','*');
CkJsonObject_UpdateString(json,'filter.to','now');
CkJsonObject_UpdateString(json,'group_by[0].facet','<string>');
CkJsonObject_UpdateString(json,'group_by[0].histogram.interval','<double>');
CkJsonObject_UpdateString(json,'group_by[0].histogram.min','<double>');
CkJsonObject_UpdateString(json,'group_by[0].histogram.max','<double>');
CkJsonObject_UpdateInt(json,'group_by[0].limit',10);
CkJsonObject_UpdateString(json,'group_by[0].missing','<string>');
CkJsonObject_UpdateString(json,'group_by[0].sort.aggregation','delta');
CkJsonObject_UpdateString(json,'group_by[0].sort.metric','<string>');
CkJsonObject_UpdateString(json,'group_by[0].sort.order','asc');
CkJsonObject_UpdateString(json,'group_by[0].sort.type','alphabetical');
CkJsonObject_UpdateString(json,'group_by[0].total','<boolean>');
CkJsonObject_UpdateString(json,'group_by[1].facet','<string>');
CkJsonObject_UpdateString(json,'group_by[1].histogram.interval','<double>');
CkJsonObject_UpdateString(json,'group_by[1].histogram.min','<double>');
CkJsonObject_UpdateString(json,'group_by[1].histogram.max','<double>');
CkJsonObject_UpdateInt(json,'group_by[1].limit',10);
CkJsonObject_UpdateString(json,'group_by[1].missing','<string>');
CkJsonObject_UpdateString(json,'group_by[1].sort.aggregation','pc99');
CkJsonObject_UpdateString(json,'group_by[1].sort.metric','<string>');
CkJsonObject_UpdateString(json,'group_by[1].sort.order','desc');
CkJsonObject_UpdateString(json,'group_by[1].sort.type','alphabetical');
CkJsonObject_UpdateString(json,'group_by[1].total','<boolean>');
CkJsonObject_UpdateString(json,'options.time_offset','<long>');
CkJsonObject_UpdateString(json,'options.timezone','UTC');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_PostJson3(http,'https://api.app.ddog-gov.com/api/v2/ci/pipelines/analytics/aggregate','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "buckets": [
// {
// "by": {
// "reprehenderit461": {
// "description": "The values for each group-by."
// },
// "qui72": {
// "description": "The values for each group-by."
// }
// },
// "computes": {
// "dolore4": "<string>"
// }
// },
// {
// "by": {
// "proident9a": {
// "description": "The values for each group-by."
// }
// },
// "computes": {
// "Lorem62": "<string>",
// "ut5": "<string>"
// }
// }
// ]
// },
// "links": {
// "next": "<string>"
// },
// "meta": {
// "elapsed": "<long>",
// "request_id": "<string>",
// "status": "done",
// "warnings": [
// {
// "code": "<string>",
// "detail": "<string>",
// "title": "<string>"
// },
// {
// "code": "<string>",
// "detail": "<string>",
// "title": "<string>"
// }
// ]
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
v_Next := CkJsonObject__stringOf(jResp,'links.next');
Elapsed := CkJsonObject__stringOf(jResp,'meta.elapsed');
Request_id := CkJsonObject__stringOf(jResp,'meta.request_id');
Status := CkJsonObject__stringOf(jResp,'meta.status');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data.buckets');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
Description := CkJsonObject__stringOf(jResp,'data.buckets[i].by.reprehenderit461.description');
Qui72Description := CkJsonObject__stringOf(jResp,'data.buckets[i].by.qui72.description');
Dolore4 := CkJsonObject__stringOf(jResp,'data.buckets[i].computes.dolore4');
Proident9aDescription := CkJsonObject__stringOf(jResp,'data.buckets[i].by.proident9a.description');
Lorem62 := CkJsonObject__stringOf(jResp,'data.buckets[i].computes.Lorem62');
Ut5 := CkJsonObject__stringOf(jResp,'data.buckets[i].computes.ut5');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'meta.warnings');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
code := CkJsonObject__stringOf(jResp,'meta.warnings[i].code');
detail := CkJsonObject__stringOf(jResp,'meta.warnings[i].detail');
title := CkJsonObject__stringOf(jResp,'meta.warnings[i].title');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"compute": [
{
"aggregation": "pc95",
"interval": "<string>",
"metric": "<string>",
"type": "total"
},
{
"aggregation": "avg",
"interval": "<string>",
"metric": "<string>",
"type": "total"
}
],
"filter": {
"from": "now-15m",
"query": "*",
"to": "now"
},
"group_by": [
{
"facet": "<string>",
"histogram": {
"interval": "<double>",
"min": "<double>",
"max": "<double>"
},
"limit": 10,
"missing": "<string>",
"sort": {
"aggregation": "delta",
"metric": "<string>",
"order": "asc",
"type": "alphabetical"
},
"total": "<boolean>"
},
{
"facet": "<string>",
"histogram": {
"interval": "<double>",
"min": "<double>",
"max": "<double>"
},
"limit": 10,
"missing": "<string>",
"sort": {
"aggregation": "pc99",
"metric": "<string>",
"order": "desc",
"type": "alphabetical"
},
"total": "<boolean>"
}
],
"options": {
"time_offset": "<long>",
"timezone": "UTC"
}
}'
https://api.app.ddog-gov.com/api/v2/ci/pipelines/analytics/aggregate
Postman Collection Item JSON
{
"name": "Aggregate pipelines events",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc95\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"delta\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n },\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"pc99\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"time_offset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"analytics",
"aggregate"
]
},
"description": "Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc95\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"delta\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n },\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"pc99\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"time_offset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"analytics",
"aggregate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"buckets\": [\n {\n \"by\": {\n \"reprehenderit461\": {\n \"description\": \"The values for each group-by.\"\n },\n \"qui72\": {\n \"description\": \"The values for each group-by.\"\n }\n },\n \"computes\": {\n \"dolore4\": \"<string>\"\n }\n },\n {\n \"by\": {\n \"proident9a\": {\n \"description\": \"The values for each group-by.\"\n }\n },\n \"computes\": {\n \"Lorem62\": \"<string>\",\n \"ut5\": \"<string>\"\n }\n }\n ]\n },\n \"links\": {\n \"next\": \"<string>\"\n },\n \"meta\": {\n \"elapsed\": \"<long>\",\n \"request_id\": \"<string>\",\n \"status\": \"done\",\n \"warnings\": [\n {\n \"code\": \"<string>\",\n \"detail\": \"<string>\",\n \"title\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"detail\": \"<string>\",\n \"title\": \"<string>\"\n }\n ]\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc95\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"delta\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n },\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"pc99\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"time_offset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"analytics",
"aggregate"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc95\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"delta\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n },\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"pc99\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"time_offset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"analytics",
"aggregate"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc95\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"delta\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n },\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"pc99\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"time_offset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"analytics",
"aggregate"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
