Chilkat Online Tools

Node.js / Datadog API Collection / Aggregate pipelines events

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();
    var success;

    // 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"
    //   }
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("compute[0].aggregation","pc95");
    json.UpdateString("compute[0].interval","<string>");
    json.UpdateString("compute[0].metric","<string>");
    json.UpdateString("compute[0].type","total");
    json.UpdateString("compute[1].aggregation","avg");
    json.UpdateString("compute[1].interval","<string>");
    json.UpdateString("compute[1].metric","<string>");
    json.UpdateString("compute[1].type","total");
    json.UpdateString("filter.from","now-15m");
    json.UpdateString("filter.query","*");
    json.UpdateString("filter.to","now");
    json.UpdateString("group_by[0].facet","<string>");
    json.UpdateString("group_by[0].histogram.interval","<double>");
    json.UpdateString("group_by[0].histogram.min","<double>");
    json.UpdateString("group_by[0].histogram.max","<double>");
    json.UpdateInt("group_by[0].limit",10);
    json.UpdateString("group_by[0].missing","<string>");
    json.UpdateString("group_by[0].sort.aggregation","delta");
    json.UpdateString("group_by[0].sort.metric","<string>");
    json.UpdateString("group_by[0].sort.order","asc");
    json.UpdateString("group_by[0].sort.type","alphabetical");
    json.UpdateString("group_by[0].total","<boolean>");
    json.UpdateString("group_by[1].facet","<string>");
    json.UpdateString("group_by[1].histogram.interval","<double>");
    json.UpdateString("group_by[1].histogram.min","<double>");
    json.UpdateString("group_by[1].histogram.max","<double>");
    json.UpdateInt("group_by[1].limit",10);
    json.UpdateString("group_by[1].missing","<string>");
    json.UpdateString("group_by[1].sort.aggregation","pc99");
    json.UpdateString("group_by[1].sort.metric","<string>");
    json.UpdateString("group_by[1].sort.order","desc");
    json.UpdateString("group_by[1].sort.type","alphabetical");
    json.UpdateString("group_by[1].total","<boolean>");
    json.UpdateString("options.time_offset","<long>");
    json.UpdateString("options.timezone","UTC");

    http.SetRequestHeader("Content-Type","application/json");
    http.SetRequestHeader("Accept","application/json");

    // resp: HttpResponse
    var resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/ci/pipelines/analytics/aggregate","application/json",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

    // 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

    var Description;
    var Qui72Description;
    var Dolore4;
    var Proident9aDescription;
    var Lorem62;
    var Ut5;
    var code;
    var detail;
    var title;

    var v_Next = jResp.StringOf("links.next");
    var Elapsed = jResp.StringOf("meta.elapsed");
    var Request_id = jResp.StringOf("meta.request_id");
    var Status = jResp.StringOf("meta.status");
    var i = 0;
    var count_i = jResp.SizeOfArray("data.buckets");
    while (i < count_i) {
        jResp.I = i;
        Description = jResp.StringOf("data.buckets[i].by.reprehenderit461.description");
        Qui72Description = jResp.StringOf("data.buckets[i].by.qui72.description");
        Dolore4 = jResp.StringOf("data.buckets[i].computes.dolore4");
        Proident9aDescription = jResp.StringOf("data.buckets[i].by.proident9a.description");
        Lorem62 = jResp.StringOf("data.buckets[i].computes.Lorem62");
        Ut5 = jResp.StringOf("data.buckets[i].computes.ut5");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("meta.warnings");
    while (i < count_i) {
        jResp.I = i;
        code = jResp.StringOf("meta.warnings[i].code");
        detail = jResp.StringOf("meta.warnings[i].detail");
        title = jResp.StringOf("meta.warnings[i].title");
        i = i+1;
    }


}

chilkatExample();

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}"
    }
  ]
}