Chilkat Online Tools

Swift3 / Datadog API Collection / Aggregate tests events

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    // 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": "delta",
    //       "interval": "<string>",
    //       "metric": "<string>",
    //       "type": "total"
    //     },
    //     {
    //       "aggregation": "pc90",
    //       "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": "pc98",
    //         "metric": "<string>",
    //         "order": "desc",
    //         "type": "alphabetical"
    //       },
    //       "total": "<boolean>"
    //     },
    //     {
    //       "facet": "<string>",
    //       "histogram": {
    //         "interval": "<double>",
    //         "min": "<double>",
    //         "max": "<double>"
    //       },
    //       "limit": 10,
    //       "missing": "<string>",
    //       "sort": {
    //         "aggregation": "pc90",
    //         "metric": "<string>",
    //         "order": "asc",
    //         "type": "alphabetical"
    //       },
    //       "total": "<boolean>"
    //     }
    //   ],
    //   "options": {
    //     "time_offset": "<long>",
    //     "timezone": "UTC"
    //   }
    // }

    let json = CkoJsonObject()!
    json.update("compute[0].aggregation", value: "delta")
    json.update("compute[0].interval", value: "<string>")
    json.update("compute[0].metric", value: "<string>")
    json.update("compute[0].type", value: "total")
    json.update("compute[1].aggregation", value: "pc90")
    json.update("compute[1].interval", value: "<string>")
    json.update("compute[1].metric", value: "<string>")
    json.update("compute[1].type", value: "total")
    json.update("filter.from", value: "now-15m")
    json.update("filter.query", value: "*")
    json.update("filter.to", value: "now")
    json.update("group_by[0].facet", value: "<string>")
    json.update("group_by[0].histogram.interval", value: "<double>")
    json.update("group_by[0].histogram.min", value: "<double>")
    json.update("group_by[0].histogram.max", value: "<double>")
    json.updateInt("group_by[0].limit", value: 10)
    json.update("group_by[0].missing", value: "<string>")
    json.update("group_by[0].sort.aggregation", value: "pc98")
    json.update("group_by[0].sort.metric", value: "<string>")
    json.update("group_by[0].sort.order", value: "desc")
    json.update("group_by[0].sort.type", value: "alphabetical")
    json.update("group_by[0].total", value: "<boolean>")
    json.update("group_by[1].facet", value: "<string>")
    json.update("group_by[1].histogram.interval", value: "<double>")
    json.update("group_by[1].histogram.min", value: "<double>")
    json.update("group_by[1].histogram.max", value: "<double>")
    json.updateInt("group_by[1].limit", value: 10)
    json.update("group_by[1].missing", value: "<string>")
    json.update("group_by[1].sort.aggregation", value: "pc90")
    json.update("group_by[1].sort.metric", value: "<string>")
    json.update("group_by[1].sort.order", value: "asc")
    json.update("group_by[1].sort.type", value: "alphabetical")
    json.update("group_by[1].total", value: "<boolean>")
    json.update("options.time_offset", value: "<long>")
    json.update("options.timezone", value: "UTC")

    http.setRequestHeader("Content-Type", value: "application/json")
    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.postJson3("https://api.app.ddog-gov.com/api/v2/ci/tests/analytics/aggregate", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "data": {
    //     "buckets": [
    //       {
    //         "by": {
    //           "adipisicing_68": {
    //             "description": "The values for each group-by."
    //           },
    //           "cupidatat7c": {
    //             "description": "The values for each group-by."
    //           }
    //         },
    //         "computes": {
    //           "Lorem_8": "<string>"
    //         }
    //       },
    //       {
    //         "by": {
    //           "inb": {
    //             "description": "The values for each group-by."
    //           },
    //           "inf": {
    //             "description": "The values for each group-by."
    //           }
    //         },
    //         "computes": {
    //           "dolore98_": "<string>"
    //         }
    //       }
    //     ]
    //   },
    //   "links": {
    //     "next": "<string>"
    //   },
    //   "meta": {
    //     "elapsed": "<long>",
    //     "page": {
    //       "after": "<string>"
    //     },
    //     "request_id": "<string>",
    //     "status": "timeout",
    //     "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: String?
    var Cupidatat7cDescription: String?
    var Lorem_8: String?
    var InbDescription: String?
    var InfDescription: String?
    var Dolore98_: String?
    var code: String?
    var detail: String?
    var title: String?

    var v_Next: String? = jResp.string(of: "links.next")
    var Elapsed: String? = jResp.string(of: "meta.elapsed")
    var After: String? = jResp.string(of: "meta.page.after")
    var Request_id: String? = jResp.string(of: "meta.request_id")
    var Status: String? = jResp.string(of: "meta.status")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "data.buckets").intValue
    while i < count_i {
        jResp.i = i
        Description = jResp.string(of: "data.buckets[i].by.adipisicing_68.description")
        Cupidatat7cDescription = jResp.string(of: "data.buckets[i].by.cupidatat7c.description")
        Lorem_8 = jResp.string(of: "data.buckets[i].computes.Lorem_8")
        InbDescription = jResp.string(of: "data.buckets[i].by.inb.description")
        InfDescription = jResp.string(of: "data.buckets[i].by.inf.description")
        Dolore98_ = jResp.string(of: "data.buckets[i].computes.dolore98_")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "meta.warnings").intValue
    while i < count_i {
        jResp.i = i
        code = jResp.string(of: "meta.warnings[i].code")
        detail = jResp.string(of: "meta.warnings[i].detail")
        title = jResp.string(of: "meta.warnings[i].title")
        i = i + 1
    }


}

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "compute": [
    {
      "aggregation": "delta",
      "interval": "<string>",
      "metric": "<string>",
      "type": "total"
    },
    {
      "aggregation": "pc90",
      "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": "pc98",
        "metric": "<string>",
        "order": "desc",
        "type": "alphabetical"
      },
      "total": "<boolean>"
    },
    {
      "facet": "<string>",
      "histogram": {
        "interval": "<double>",
        "min": "<double>",
        "max": "<double>"
      },
      "limit": 10,
      "missing": "<string>",
      "sort": {
        "aggregation": "pc90",
        "metric": "<string>",
        "order": "asc",
        "type": "alphabetical"
      },
      "total": "<boolean>"
    }
  ],
  "options": {
    "time_offset": "<long>",
    "timezone": "UTC"
  }
}'
https://api.app.ddog-gov.com/api/v2/ci/tests/analytics/aggregate

Postman Collection Item JSON

{
  "name": "Aggregate tests 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\": \"delta\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    },\n    {\n      \"aggregation\": \"pc90\",\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\": \"pc98\",\n        \"metric\": \"<string>\",\n        \"order\": \"desc\",\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\": \"pc90\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\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/tests/analytics/aggregate",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "ci",
        "tests",
        "analytics",
        "aggregate"
      ]
    },
    "description": "The API endpoint to aggregate CI Visibility test 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\": \"delta\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    },\n    {\n      \"aggregation\": \"pc90\",\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\": \"pc98\",\n        \"metric\": \"<string>\",\n        \"order\": \"desc\",\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\": \"pc90\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\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/tests/analytics/aggregate",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ci",
            "tests",
            "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          \"adipisicing_68\": {\n            \"description\": \"The values for each group-by.\"\n          },\n          \"cupidatat7c\": {\n            \"description\": \"The values for each group-by.\"\n          }\n        },\n        \"computes\": {\n          \"Lorem_8\": \"<string>\"\n        }\n      },\n      {\n        \"by\": {\n          \"inb\": {\n            \"description\": \"The values for each group-by.\"\n          },\n          \"inf\": {\n            \"description\": \"The values for each group-by.\"\n          }\n        },\n        \"computes\": {\n          \"dolore98_\": \"<string>\"\n        }\n      }\n    ]\n  },\n  \"links\": {\n    \"next\": \"<string>\"\n  },\n  \"meta\": {\n    \"elapsed\": \"<long>\",\n    \"page\": {\n      \"after\": \"<string>\"\n    },\n    \"request_id\": \"<string>\",\n    \"status\": \"timeout\",\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\": \"delta\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    },\n    {\n      \"aggregation\": \"pc90\",\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\": \"pc98\",\n        \"metric\": \"<string>\",\n        \"order\": \"desc\",\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\": \"pc90\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\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/tests/analytics/aggregate",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ci",
            "tests",
            "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\": \"delta\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    },\n    {\n      \"aggregation\": \"pc90\",\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\": \"pc98\",\n        \"metric\": \"<string>\",\n        \"order\": \"desc\",\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\": \"pc90\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\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/tests/analytics/aggregate",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ci",
            "tests",
            "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\": \"delta\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    },\n    {\n      \"aggregation\": \"pc90\",\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\": \"pc98\",\n        \"metric\": \"<string>\",\n        \"order\": \"desc\",\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\": \"pc90\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\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/tests/analytics/aggregate",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ci",
            "tests",
            "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}"
    }
  ]
}