Chilkat Online Tools

Ruby / Datadog API Collection / Get all span-based metrics

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/apm/config/metrics",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

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

# {
#   "data": [
#     {
#       "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": "spans_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": "spans_metrics"
#     }
#   ]
# }

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

i = 0
count_i = jResp.SizeOfArray("data")
while i < count_i
    jResp.put_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.put_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
    end
    i = i + 1
end

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get all span-based metrics",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/apm/config/metrics",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "apm",
        "config",
        "metrics"
      ]
    },
    "description": "Get the list of configured span-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/apm/config/metrics",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "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\": \"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\": \"spans_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\": \"spans_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/apm/config/metrics",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "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/apm/config/metrics",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "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}"
    }
  ]
}