Chilkat Online Tools

Swift3 / Datadog API Collection / Query timeseries points

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

    let queryParams = CkoJsonObject()!
    queryParams.updateInt("from", value: -62147425)
    queryParams.updateInt("to", value: -62147425)
    queryParams.update("query", value: "tempor Ut sed velit")

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

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.app.ddog-gov.com/api/v1/query", json: queryParams)
    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)

    // {
    //   "error": "officia dolor dolor enim Ut",
    //   "from_date": 74851718,
    //   "group_by": [
    //     "Ut sint veniam voluptate id",
    //     "laborum dolore fugiat quis"
    //   ],
    //   "message": "commodo Duis dolore",
    //   "query": "irure nulla",
    //   "res_type": "time_series",
    //   "series": [
    //     {
    //       "aggr": "avg",
    //       "display_name": "system.cpu.idle",
    //       "end": 40693612,
    //       "expression": "system.cpu.idle{host:foo,env:test}",
    //       "interval": 40405386,
    //       "length": -62156772,
    //       "metric": "system.cpu.idle",
    //       "pointlist": [
    //         [
    //           1681683300000,
    //           77.62145685254418
    //         ]
    //       ],
    //       "query_index": -41586801,
    //       "scope": "host:foo,env:test",
    //       "start": -45245073,
    //       "tag_set": [
    //         "aute incididunt enim",
    //         "dolore mollit amet esse"
    //       ],
    //       "unit": [
    //         {
    //           "family": "time",
    //           "name": "minute",
    //           "plural": "minutes",
    //           "scale_factor": 60,
    //           "short_name": "min"
    //         },
    //         {
    //           "family": "time",
    //           "name": "minute",
    //           "plural": "minutes",
    //           "scale_factor": 60,
    //           "short_name": "min"
    //         }
    //       ]
    //     },
    //     {
    //       "aggr": "avg",
    //       "display_name": "system.cpu.idle",
    //       "end": -49813044,
    //       "expression": "system.cpu.idle{host:foo,env:test}",
    //       "interval": -86046844,
    //       "length": 71311767,
    //       "metric": "system.cpu.idle",
    //       "pointlist": [
    //         [
    //           1681683300000,
    //           77.62145685254418
    //         ]
    //       ],
    //       "query_index": -70553970,
    //       "scope": "host:foo,env:test",
    //       "start": 3842833,
    //       "tag_set": [
    //         "sit enim consectetur",
    //         "Duis"
    //       ],
    //       "unit": [
    //         {
    //           "family": "time",
    //           "name": "minute",
    //           "plural": "minutes",
    //           "scale_factor": 60,
    //           "short_name": "min"
    //         },
    //         {
    //           "family": "time",
    //           "name": "minute",
    //           "plural": "minutes",
    //           "scale_factor": 60,
    //           "short_name": "min"
    //         }
    //       ]
    //     }
    //   ],
    //   "status": "ok",
    //   "to_date": 39411541
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var strVal: String?
    var aggr: String?
    var display_name: String?
    var v_end: Int
    var expression: String?
    var interval: Int
    var length: Int
    var metric: String?
    var query_index: Int
    var scope: String?
    var start: Int
    var j: Int
    var count_j: Int
    var k: Int
    var count_k: Int
    var intVal: Int
    var family: String?
    var name: String?
    var plural: String?
    var scale_factor: Int
    var short_name: String?

    var error: String? = jResp.string(of: "error")
    var from_date: Int = jResp.int(of: "from_date").intValue
    var message: String? = jResp.string(of: "message")
    var query: String? = jResp.string(of: "query")
    var res_type: String? = jResp.string(of: "res_type")
    var status: String? = jResp.string(of: "status")
    var to_date: Int = jResp.int(of: "to_date").intValue
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "group_by").intValue
    while i < count_i {
        jResp.i = i
        strVal = jResp.string(of: "group_by[i]")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "series").intValue
    while i < count_i {
        jResp.i = i
        aggr = jResp.string(of: "series[i].aggr")
        display_name = jResp.string(of: "series[i].display_name")
        v_end = jResp.int(of: "series[i].end").intValue
        expression = jResp.string(of: "series[i].expression")
        interval = jResp.int(of: "series[i].interval").intValue
        length = jResp.int(of: "series[i].length").intValue
        metric = jResp.string(of: "series[i].metric")
        query_index = jResp.int(of: "series[i].query_index").intValue
        scope = jResp.string(of: "series[i].scope")
        start = jResp.int(of: "series[i].start").intValue
        j = 0
        count_j = jResp.size(ofArray: "series[i].pointlist").intValue
        while j < count_j {
            jResp.j = j
            k = 0
            count_k = jResp.size(ofArray: "series[i].pointlist[j]").intValue
            while k < count_k {
                jResp.k = k
                intVal = jResp.int(of: "series[i].pointlist[j][k]").intValue
                k = k + 1
            }

            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "series[i].tag_set").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "series[i].tag_set[j]")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "series[i].unit").intValue
        while j < count_j {
            jResp.j = j
            family = jResp.string(of: "series[i].unit[j].family")
            name = jResp.string(of: "series[i].unit[j].name")
            plural = jResp.string(of: "series[i].unit[j].plural")
            scale_factor = jResp.int(of: "series[i].unit[j].scale_factor").intValue
            short_name = jResp.string(of: "series[i].unit[j].short_name")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl -G -d "from=-62147425"
	-d "to=-62147425"
	-d "query=tempor%20Ut%20sed%20velit"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/query

Postman Collection Item JSON

{
  "name": "Query timeseries points",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/query?from=-62147425&to=-62147425&query=tempor Ut sed velit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "query"
      ],
      "query": [
        {
          "key": "from",
          "value": "-62147425",
          "description": "(Required) Start of the queried time period, seconds since the Unix epoch."
        },
        {
          "key": "to",
          "value": "-62147425",
          "description": "(Required) End of the queried time period, seconds since the Unix epoch."
        },
        {
          "key": "query",
          "value": "tempor Ut sed velit",
          "description": "(Required) Query string."
        }
      ]
    },
    "description": "Query timeseries points."
  },
  "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/query?from=-62147425&to=-62147425&query=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "query"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Start of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "to",
              "value": "-62147425",
              "description": "(Required) End of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "(Required) Query string."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"error\": \"officia dolor dolor enim Ut\",\n  \"from_date\": 74851718,\n  \"group_by\": [\n    \"Ut sint veniam voluptate id\",\n    \"laborum dolore fugiat quis\"\n  ],\n  \"message\": \"commodo Duis dolore\",\n  \"query\": \"irure nulla\",\n  \"res_type\": \"time_series\",\n  \"series\": [\n    {\n      \"aggr\": \"avg\",\n      \"display_name\": \"system.cpu.idle\",\n      \"end\": 40693612,\n      \"expression\": \"system.cpu.idle{host:foo,env:test}\",\n      \"interval\": 40405386,\n      \"length\": -62156772,\n      \"metric\": \"system.cpu.idle\",\n      \"pointlist\": [\n        [\n          1681683300000,\n          77.62145685254418\n        ]\n      ],\n      \"query_index\": -41586801,\n      \"scope\": \"host:foo,env:test\",\n      \"start\": -45245073,\n      \"tag_set\": [\n        \"aute incididunt enim\",\n        \"dolore mollit amet esse\"\n      ],\n      \"unit\": [\n        {\n          \"family\": \"time\",\n          \"name\": \"minute\",\n          \"plural\": \"minutes\",\n          \"scale_factor\": 60,\n          \"short_name\": \"min\"\n        },\n        {\n          \"family\": \"time\",\n          \"name\": \"minute\",\n          \"plural\": \"minutes\",\n          \"scale_factor\": 60,\n          \"short_name\": \"min\"\n        }\n      ]\n    },\n    {\n      \"aggr\": \"avg\",\n      \"display_name\": \"system.cpu.idle\",\n      \"end\": -49813044,\n      \"expression\": \"system.cpu.idle{host:foo,env:test}\",\n      \"interval\": -86046844,\n      \"length\": 71311767,\n      \"metric\": \"system.cpu.idle\",\n      \"pointlist\": [\n        [\n          1681683300000,\n          77.62145685254418\n        ]\n      ],\n      \"query_index\": -70553970,\n      \"scope\": \"host:foo,env:test\",\n      \"start\": 3842833,\n      \"tag_set\": [\n        \"sit enim consectetur\",\n        \"Duis\"\n      ],\n      \"unit\": [\n        {\n          \"family\": \"time\",\n          \"name\": \"minute\",\n          \"plural\": \"minutes\",\n          \"scale_factor\": 60,\n          \"short_name\": \"min\"\n        },\n        {\n          \"family\": \"time\",\n          \"name\": \"minute\",\n          \"plural\": \"minutes\",\n          \"scale_factor\": 60,\n          \"short_name\": \"min\"\n        }\n      ]\n    }\n  ],\n  \"status\": \"ok\",\n  \"to_date\": 39411541\n}"
    },
    {
      "name": "Bad Request",
      "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/query?from=-62147425&to=-62147425&query=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "query"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Start of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "to",
              "value": "-62147425",
              "description": "(Required) End of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "(Required) Query string."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "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/query?from=-62147425&to=-62147425&query=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "query"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Start of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "to",
              "value": "-62147425",
              "description": "(Required) End of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "(Required) Query string."
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_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/query?from=-62147425&to=-62147425&query=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "query"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Start of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "to",
              "value": "-62147425",
              "description": "(Required) End of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "(Required) Query string."
            }
          ]
        }
      },
      "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}"
    }
  ]
}