Chilkat Online Tools

Ruby / Datadog API Collection / Get a list of 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()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("filter[configured]","<boolean>")
queryParams.UpdateString("filter[tags_configured]","<string>")
queryParams.UpdateString("filter[metric_type]","gauge")
queryParams.UpdateString("filter[include_percentiles]","<boolean>")
queryParams.UpdateString("filter[queried]","<boolean>")
queryParams.UpdateString("filter[tags]","<string>")
queryParams.UpdateString("window[seconds]","<long>")

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/metrics",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

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

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

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "data": [
#     {
#       "id": "<string>",
#       "type": "metrics"
#     },
#     {
#       "id": "<string>",
#       "type": "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)
    id = jResp.stringOf("data[i].id")
    v_type = jResp.stringOf("data[i].type")
    i = i + 1
end

Curl Command

curl -G -d "filter[configured]=%3Cboolean%3E"
	-d "filter[tags_configured]=%3Cstring%3E"
	-d "filter[metric_type]=gauge"
	-d "filter[include_percentiles]=%3Cboolean%3E"
	-d "filter[queried]=%3Cboolean%3E"
	-d "filter[tags]=%3Cstring%3E"
	-d "window[seconds]=%3Clong%3E"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/metrics

Postman Collection Item JSON

{
  "name": "Get a list of metrics",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/metrics?filter[configured]=<boolean>&filter[tags_configured]=<string>&filter[metric_type]=gauge&filter[include_percentiles]=<boolean>&filter[queried]=<boolean>&filter[tags]=<string>&window[seconds]=<long>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "metrics"
      ],
      "query": [
        {
          "key": "filter[configured]",
          "value": "<boolean>",
          "description": "Filter custom metrics that have configured tags."
        },
        {
          "key": "filter[tags_configured]",
          "value": "<string>",
          "description": "Filter tag configurations by configured tags."
        },
        {
          "key": "filter[metric_type]",
          "value": "gauge",
          "description": "Filter metrics by metric type."
        },
        {
          "key": "filter[include_percentiles]",
          "value": "<boolean>",
          "description": "Filter distributions with additional percentile\naggregations enabled or disabled."
        },
        {
          "key": "filter[queried]",
          "value": "<boolean>",
          "description": "Filter custom metrics that have or have not been queried in the specified window[seconds].\nIf no window is provided or the window is less than 2 hours, a default of 2 hours will be applied."
        },
        {
          "key": "filter[tags]",
          "value": "<string>",
          "description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCan only be combined with the filter[queried] filter."
        },
        {
          "key": "window[seconds]",
          "value": "<long>",
          "description": "The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.\nDefault value is 3600 (1 hour), maximum value is 2,592,000 (30 days)."
        }
      ]
    },
    "description": "Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified)."
  },
  "response": [
    {
      "name": "Success",
      "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/metrics?filter[configured]=<boolean>&filter[tags_configured]=<string>&filter[metric_type]=gauge&filter[include_percentiles]=<boolean>&filter[queried]=<boolean>&filter[tags]=<string>&window[seconds]=<long>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics"
          ],
          "query": [
            {
              "key": "filter[configured]",
              "value": "<boolean>",
              "description": "Filter custom metrics that have configured tags."
            },
            {
              "key": "filter[tags_configured]",
              "value": "<string>",
              "description": "Filter tag configurations by configured tags."
            },
            {
              "key": "filter[metric_type]",
              "value": "gauge",
              "description": "Filter metrics by metric type."
            },
            {
              "key": "filter[include_percentiles]",
              "value": "<boolean>",
              "description": "Filter distributions with additional percentile\naggregations enabled or disabled."
            },
            {
              "key": "filter[queried]",
              "value": "<boolean>",
              "description": "Filter custom metrics that have or have not been queried in the specified window[seconds].\nIf no window is provided or the window is less than 2 hours, a default of 2 hours will be applied."
            },
            {
              "key": "filter[tags]",
              "value": "<string>",
              "description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCan only be combined with the filter[queried] filter."
            },
            {
              "key": "window[seconds]",
              "value": "<long>",
              "description": "The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.\nDefault value is 3600 (1 hour), maximum value is 2,592,000 (30 days)."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"id\": \"<string>\",\n      \"type\": \"metrics\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"type\": \"metrics\"\n    }\n  ]\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/v2/metrics?filter[configured]=<boolean>&filter[tags_configured]=<string>&filter[metric_type]=gauge&filter[include_percentiles]=<boolean>&filter[queried]=<boolean>&filter[tags]=<string>&window[seconds]=<long>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics"
          ],
          "query": [
            {
              "key": "filter[configured]",
              "value": "<boolean>",
              "description": "Filter custom metrics that have configured tags."
            },
            {
              "key": "filter[tags_configured]",
              "value": "<string>",
              "description": "Filter tag configurations by configured tags."
            },
            {
              "key": "filter[metric_type]",
              "value": "gauge",
              "description": "Filter metrics by metric type."
            },
            {
              "key": "filter[include_percentiles]",
              "value": "<boolean>",
              "description": "Filter distributions with additional percentile\naggregations enabled or disabled."
            },
            {
              "key": "filter[queried]",
              "value": "<boolean>",
              "description": "Filter custom metrics that have or have not been queried in the specified window[seconds].\nIf no window is provided or the window is less than 2 hours, a default of 2 hours will be applied."
            },
            {
              "key": "filter[tags]",
              "value": "<string>",
              "description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCan only be combined with the filter[queried] filter."
            },
            {
              "key": "window[seconds]",
              "value": "<long>",
              "description": "The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.\nDefault value is 3600 (1 hour), maximum value is 2,592,000 (30 days)."
            }
          ]
        }
      },
      "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": "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/v2/metrics?filter[configured]=<boolean>&filter[tags_configured]=<string>&filter[metric_type]=gauge&filter[include_percentiles]=<boolean>&filter[queried]=<boolean>&filter[tags]=<string>&window[seconds]=<long>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics"
          ],
          "query": [
            {
              "key": "filter[configured]",
              "value": "<boolean>",
              "description": "Filter custom metrics that have configured tags."
            },
            {
              "key": "filter[tags_configured]",
              "value": "<string>",
              "description": "Filter tag configurations by configured tags."
            },
            {
              "key": "filter[metric_type]",
              "value": "gauge",
              "description": "Filter metrics by metric type."
            },
            {
              "key": "filter[include_percentiles]",
              "value": "<boolean>",
              "description": "Filter distributions with additional percentile\naggregations enabled or disabled."
            },
            {
              "key": "filter[queried]",
              "value": "<boolean>",
              "description": "Filter custom metrics that have or have not been queried in the specified window[seconds].\nIf no window is provided or the window is less than 2 hours, a default of 2 hours will be applied."
            },
            {
              "key": "filter[tags]",
              "value": "<string>",
              "description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCan only be combined with the filter[queried] filter."
            },
            {
              "key": "window[seconds]",
              "value": "<long>",
              "description": "The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.\nDefault value is 3600 (1 hour), maximum value is 2,592,000 (30 days)."
            }
          ]
        }
      },
      "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/metrics?filter[configured]=<boolean>&filter[tags_configured]=<string>&filter[metric_type]=gauge&filter[include_percentiles]=<boolean>&filter[queried]=<boolean>&filter[tags]=<string>&window[seconds]=<long>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics"
          ],
          "query": [
            {
              "key": "filter[configured]",
              "value": "<boolean>",
              "description": "Filter custom metrics that have configured tags."
            },
            {
              "key": "filter[tags_configured]",
              "value": "<string>",
              "description": "Filter tag configurations by configured tags."
            },
            {
              "key": "filter[metric_type]",
              "value": "gauge",
              "description": "Filter metrics by metric type."
            },
            {
              "key": "filter[include_percentiles]",
              "value": "<boolean>",
              "description": "Filter distributions with additional percentile\naggregations enabled or disabled."
            },
            {
              "key": "filter[queried]",
              "value": "<boolean>",
              "description": "Filter custom metrics that have or have not been queried in the specified window[seconds].\nIf no window is provided or the window is less than 2 hours, a default of 2 hours will be applied."
            },
            {
              "key": "filter[tags]",
              "value": "<string>",
              "description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCan only be combined with the filter[queried] filter."
            },
            {
              "key": "window[seconds]",
              "value": "<long>",
              "description": "The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.\nDefault value is 3600 (1 hour), maximum value is 2,592,000 (30 days)."
            }
          ]
        }
      },
      "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}"
    }
  ]
}