Chilkat Online Tools

Xojo / Datadog API Collection / Get all log-based metrics

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

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/logs/config/metrics",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

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 = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

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

// {
//   "data": [
//     {
//       "attributes": {
//         "compute": {
//           "aggregation_type": "count",
//           "include_percentiles": "<boolean>",
//           "path": "<string>"
//         },
//         "filter": {
//           "query": "<string>"
//         },
//         "group_by": [
//           {
//             "path": "<string>",
//             "tag_name": "<string>"
//           },
//           {
//             "path": "<string>",
//             "tag_name": "<string>"
//           }
//         ]
//       },
//       "id": "<string>",
//       "type": "logs_metrics"
//     },
//     {
//       "attributes": {
//         "compute": {
//           "aggregation_type": "distribution",
//           "include_percentiles": "<boolean>",
//           "path": "<string>"
//         },
//         "filter": {
//           "query": "<string>"
//         },
//         "group_by": [
//           {
//             "path": "<string>",
//             "tag_name": "<string>"
//           },
//           {
//             "path": "<string>",
//             "tag_name": "<string>"
//           }
//         ]
//       },
//       "id": "<string>",
//       "type": "logs_metrics"
//     }
//   ]
// }

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

Dim Aggregation_type As String
Dim Include_percentiles As String
Dim Path As String
Dim Query As String
Dim id As String
Dim v_type As String
Dim j As Int32
Dim count_j As Int32
Dim path As String
Dim tag_name As String

Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("data")
While i < count_i
    jResp.I = i
    Aggregation_type = jResp.StringOf("data[i].attributes.compute.aggregation_type")
    Include_percentiles = jResp.StringOf("data[i].attributes.compute.include_percentiles")
    Path = jResp.StringOf("data[i].attributes.compute.path")
    Query = jResp.StringOf("data[i].attributes.filter.query")
    id = jResp.StringOf("data[i].id")
    v_type = jResp.StringOf("data[i].type")
    j = 0
    count_j = jResp.SizeOfArray("data[i].attributes.group_by")
    While j < count_j
        jResp.J = j
        path = jResp.StringOf("data[i].attributes.group_by[j].path")
        tag_name = jResp.StringOf("data[i].attributes.group_by[j].tag_name")
        j = j + 1
    Wend
    i = i + 1
Wend

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/logs/config/metrics

Postman Collection Item JSON

{
  "name": "Get all log-based metrics",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/logs/config/metrics",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "logs",
        "config",
        "metrics"
      ]
    },
    "description": "Get the list of configured log-based metrics with their definitions."
  },
  "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/v2/logs/config/metrics",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "metrics"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"attributes\": {\n        \"compute\": {\n          \"aggregation_type\": \"count\",\n          \"include_percentiles\": \"<boolean>\",\n          \"path\": \"<string>\"\n        },\n        \"filter\": {\n          \"query\": \"<string>\"\n        },\n        \"group_by\": [\n          {\n            \"path\": \"<string>\",\n            \"tag_name\": \"<string>\"\n          },\n          {\n            \"path\": \"<string>\",\n            \"tag_name\": \"<string>\"\n          }\n        ]\n      },\n      \"id\": \"<string>\",\n      \"type\": \"logs_metrics\"\n    },\n    {\n      \"attributes\": {\n        \"compute\": {\n          \"aggregation_type\": \"distribution\",\n          \"include_percentiles\": \"<boolean>\",\n          \"path\": \"<string>\"\n        },\n        \"filter\": {\n          \"query\": \"<string>\"\n        },\n        \"group_by\": [\n          {\n            \"path\": \"<string>\",\n            \"tag_name\": \"<string>\"\n          },\n          {\n            \"path\": \"<string>\",\n            \"tag_name\": \"<string>\"\n          }\n        ]\n      },\n      \"id\": \"<string>\",\n      \"type\": \"logs_metrics\"\n    }\n  ]\n}"
    },
    {
      "name": "Not Authorized",
      "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/v2/logs/config/metrics",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "metrics"
          ]
        }
      },
      "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": "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/v2/logs/config/metrics",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "config",
            "metrics"
          ]
        }
      },
      "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}"
    }
  ]
}