Chilkat Online Tools

Xojo / Datadog API Collection / Query timeseries data across multiple products

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "data": {
//     "type": "timeseries_request",
//     "attributes": {
//       "to": "<long>",
//       "from": "<long>",
//       "queries": [
//         {
//           "data_source": "metrics",
//           "query": "<string>",
//           "name": "<string>"
//         },
//         {
//           "data_source": "metrics",
//           "query": "<string>",
//           "name": "<string>"
//         }
//       ],
//       "formulas": [
//         {
//           "formula": "<string>",
//           "limit": {
//             "count": "<integer>",
//             "order": "desc"
//           }
//         },
//         {
//           "formula": "<string>",
//           "limit": {
//             "count": "<integer>",
//             "order": "desc"
//           }
//         }
//       ],
//       "interval": "<long>"
//     }
//   }
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("data.type","timeseries_request")
success = json.UpdateString("data.attributes.to","<long>")
success = json.UpdateString("data.attributes.from","<long>")
success = json.UpdateString("data.attributes.queries[0].data_source","metrics")
success = json.UpdateString("data.attributes.queries[0].query","<string>")
success = json.UpdateString("data.attributes.queries[0].name","<string>")
success = json.UpdateString("data.attributes.queries[1].data_source","metrics")
success = json.UpdateString("data.attributes.queries[1].query","<string>")
success = json.UpdateString("data.attributes.queries[1].name","<string>")
success = json.UpdateString("data.attributes.formulas[0].formula","<string>")
success = json.UpdateString("data.attributes.formulas[0].limit.count","<integer>")
success = json.UpdateString("data.attributes.formulas[0].limit.order","desc")
success = json.UpdateString("data.attributes.formulas[1].formula","<string>")
success = json.UpdateString("data.attributes.formulas[1].limit.count","<integer>")
success = json.UpdateString("data.attributes.formulas[1].limit.order","desc")
success = json.UpdateString("data.attributes.interval","<long>")

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

Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/query/timeseries","application/json",json)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

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

// {
//   "data": {
//     "attributes": {
//       "series": [
//         {
//           "group_tags": [
//             "<string>",
//             "<string>"
//           ],
//           "query_index": "<integer>",
//           "unit": [
//             {
//               "family": "<string>",
//               "name": "<string>",
//               "plural": "<string>",
//               "scale_factor": "<double>",
//               "short_name": "<string>"
//             },
//             {
//               "family": "<string>",
//               "name": "<string>",
//               "plural": "<string>",
//               "scale_factor": "<double>",
//               "short_name": "<string>"
//             }
//           ]
//         },
//         {
//           "group_tags": [
//             "<string>",
//             "<string>"
//           ],
//           "query_index": "<integer>",
//           "unit": [
//             {
//               "family": "<string>",
//               "name": "<string>",
//               "plural": "<string>",
//               "scale_factor": "<double>",
//               "short_name": "<string>"
//             },
//             {
//               "family": "<string>",
//               "name": "<string>",
//               "plural": "<string>",
//               "scale_factor": "<double>",
//               "short_name": "<string>"
//             }
//           ]
//         }
//       ],
//       "times": [
//         "<long>",
//         "<long>"
//       ],
//       "values": [
//         [
//           "<double>",
//           "<double>"
//         ],
//         [
//           "<double>",
//           "<double>"
//         ]
//       ]
//     },
//     "type": "timeseries_response"
//   },
//   "errors": "<string>"
// }

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

Dim query_index As String
Dim j As Int32
Dim count_j As Int32
Dim strVal As String
Dim family As String
Dim name As String
Dim plural As String
Dim scale_factor As String
Dim short_name As String

Dim v_Type As String
v_Type = jResp.StringOf("data.type")
Dim errors As String
errors = jResp.StringOf("errors")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("data.attributes.series")
While i < count_i
    jResp.I = i
    query_index = jResp.StringOf("data.attributes.series[i].query_index")
    j = 0
    count_j = jResp.SizeOfArray("data.attributes.series[i].group_tags")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("data.attributes.series[i].group_tags[j]")
        j = j + 1
    Wend
    j = 0
    count_j = jResp.SizeOfArray("data.attributes.series[i].unit")
    While j < count_j
        jResp.J = j
        family = jResp.StringOf("data.attributes.series[i].unit[j].family")
        name = jResp.StringOf("data.attributes.series[i].unit[j].name")
        plural = jResp.StringOf("data.attributes.series[i].unit[j].plural")
        scale_factor = jResp.StringOf("data.attributes.series[i].unit[j].scale_factor")
        short_name = jResp.StringOf("data.attributes.series[i].unit[j].short_name")
        j = j + 1
    Wend
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("data.attributes.times")
While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("data.attributes.times[i]")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("data.attributes.values")
While i < count_i
    jResp.I = i
    j = 0
    count_j = jResp.SizeOfArray("data.attributes.values[i]")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("data.attributes.values[i][j]")
        j = j + 1
    Wend
    i = i + 1
Wend

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "type": "timeseries_request",
    "attributes": {
      "to": "<long>",
      "from": "<long>",
      "queries": [
        {
          "data_source": "metrics",
          "query": "<string>",
          "name": "<string>"
        },
        {
          "data_source": "metrics",
          "query": "<string>",
          "name": "<string>"
        }
      ],
      "formulas": [
        {
          "formula": "<string>",
          "limit": {
            "count": "<integer>",
            "order": "desc"
          }
        },
        {
          "formula": "<string>",
          "limit": {
            "count": "<integer>",
            "order": "desc"
          }
        }
      ],
      "interval": "<long>"
    }
  }
}'
https://api.app.ddog-gov.com/api/v2/query/timeseries

Postman Collection Item JSON

{
  "name": "Query timeseries data across multiple products",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"type\": \"timeseries_request\",\n    \"attributes\": {\n      \"to\": \"<long>\",\n      \"from\": \"<long>\",\n      \"queries\": [\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"formulas\": [\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        },\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        }\n      ],\n      \"interval\": \"<long>\"\n    }\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/query/timeseries",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "query",
        "timeseries"
      ]
    },
    "description": "Query timeseries data across various data sources and\nprocess the data by applying formulas and functions."
  },
  "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  \"data\": {\n    \"type\": \"timeseries_request\",\n    \"attributes\": {\n      \"to\": \"<long>\",\n      \"from\": \"<long>\",\n      \"queries\": [\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"formulas\": [\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        },\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        }\n      ],\n      \"interval\": \"<long>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/query/timeseries",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "query",
            "timeseries"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"attributes\": {\n      \"series\": [\n        {\n          \"group_tags\": [\n            \"<string>\",\n            \"<string>\"\n          ],\n          \"query_index\": \"<integer>\",\n          \"unit\": [\n            {\n              \"family\": \"<string>\",\n              \"name\": \"<string>\",\n              \"plural\": \"<string>\",\n              \"scale_factor\": \"<double>\",\n              \"short_name\": \"<string>\"\n            },\n            {\n              \"family\": \"<string>\",\n              \"name\": \"<string>\",\n              \"plural\": \"<string>\",\n              \"scale_factor\": \"<double>\",\n              \"short_name\": \"<string>\"\n            }\n          ]\n        },\n        {\n          \"group_tags\": [\n            \"<string>\",\n            \"<string>\"\n          ],\n          \"query_index\": \"<integer>\",\n          \"unit\": [\n            {\n              \"family\": \"<string>\",\n              \"name\": \"<string>\",\n              \"plural\": \"<string>\",\n              \"scale_factor\": \"<double>\",\n              \"short_name\": \"<string>\"\n            },\n            {\n              \"family\": \"<string>\",\n              \"name\": \"<string>\",\n              \"plural\": \"<string>\",\n              \"scale_factor\": \"<double>\",\n              \"short_name\": \"<string>\"\n            }\n          ]\n        }\n      ],\n      \"times\": [\n        \"<long>\",\n        \"<long>\"\n      ],\n      \"values\": [\n        [\n          \"<double>\",\n          \"<double>\"\n        ],\n        [\n          \"<double>\",\n          \"<double>\"\n        ]\n      ]\n    },\n    \"type\": \"timeseries_response\"\n  },\n  \"errors\": \"<string>\"\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  \"data\": {\n    \"type\": \"timeseries_request\",\n    \"attributes\": {\n      \"to\": \"<long>\",\n      \"from\": \"<long>\",\n      \"queries\": [\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"formulas\": [\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        },\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        }\n      ],\n      \"interval\": \"<long>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/query/timeseries",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "query",
            "timeseries"
          ]
        }
      },
      "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": "Unauthorized",
      "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  \"data\": {\n    \"type\": \"timeseries_request\",\n    \"attributes\": {\n      \"to\": \"<long>\",\n      \"from\": \"<long>\",\n      \"queries\": [\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"formulas\": [\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        },\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        }\n      ],\n      \"interval\": \"<long>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/query/timeseries",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "query",
            "timeseries"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "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  \"data\": {\n    \"type\": \"timeseries_request\",\n    \"attributes\": {\n      \"to\": \"<long>\",\n      \"from\": \"<long>\",\n      \"queries\": [\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"formulas\": [\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        },\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        }\n      ],\n      \"interval\": \"<long>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/query/timeseries",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "query",
            "timeseries"
          ]
        }
      },
      "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  \"data\": {\n    \"type\": \"timeseries_request\",\n    \"attributes\": {\n      \"to\": \"<long>\",\n      \"from\": \"<long>\",\n      \"queries\": [\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"data_source\": \"metrics\",\n          \"query\": \"<string>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"formulas\": [\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        },\n        {\n          \"formula\": \"<string>\",\n          \"limit\": {\n            \"count\": \"<integer>\",\n            \"order\": \"desc\"\n          }\n        }\n      ],\n      \"interval\": \"<long>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/query/timeseries",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "query",
            "timeseries"
          ]
        }
      },
      "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}"
    }
  ]
}