Chilkat Online Tools

Ruby / Datadog API Collection / Get active metrics list

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.UpdateInt("from",-62147425)
queryParams.UpdateString("host","tempor Ut sed velit")
queryParams.UpdateString("tag_filter","env IN (staging,test) AND service:web")

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/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)

# {
#   "from": "ullamco ut sed Duis",
#   "metrics": [
#     "sed",
#     "proident tempor eiusmod veniam"
#   ]
# }

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

from = jResp.stringOf("from")
i = 0
count_i = jResp.SizeOfArray("metrics")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("metrics[i]")
    i = i + 1
end

Curl Command

curl -G -d "from=-62147425"
	-d "host=tempor%20Ut%20sed%20velit"
	-d "tag_filter=env%20IN%20%28staging,test%29%20AND%20service%3Aweb"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/metrics

Postman Collection Item JSON

{
  "name": "Get active metrics list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/metrics?from=-62147425&host=tempor Ut sed velit&tag_filter=env IN (staging,test) AND service:web",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "metrics"
      ],
      "query": [
        {
          "key": "from",
          "value": "-62147425",
          "description": "(Required) Seconds since the Unix epoch."
        },
        {
          "key": "host",
          "value": "tempor Ut sed velit",
          "description": "Hostname for filtering the list of metrics returned.\nIf set, metrics retrieved are those with the corresponding hostname tag."
        },
        {
          "key": "tag_filter",
          "value": "env IN (staging,test) AND service:web",
          "description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCannot be combined with other filters."
        }
      ]
    },
    "description": "Get the list of actively reporting metrics from a given time until now."
  },
  "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/metrics?from=-62147425&host=tempor Ut sed velit&tag_filter=env IN (staging,test) AND service:web",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "metrics"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Seconds since the Unix epoch."
            },
            {
              "key": "host",
              "value": "tempor Ut sed velit",
              "description": "Hostname for filtering the list of metrics returned.\nIf set, metrics retrieved are those with the corresponding hostname tag."
            },
            {
              "key": "tag_filter",
              "value": "env IN (staging,test) AND service:web",
              "description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCannot be combined with other filters."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"from\": \"ullamco ut sed Duis\",\n  \"metrics\": [\n    \"sed\",\n    \"proident tempor eiusmod veniam\"\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/v1/metrics?from=-62147425&host=tempor Ut sed velit&tag_filter=env IN (staging,test) AND service:web",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "metrics"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Seconds since the Unix epoch."
            },
            {
              "key": "host",
              "value": "tempor Ut sed velit",
              "description": "Hostname for filtering the list of metrics returned.\nIf set, metrics retrieved are those with the corresponding hostname tag."
            },
            {
              "key": "tag_filter",
              "value": "env IN (staging,test) AND service:web",
              "description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCannot be combined with other filters."
            }
          ]
        }
      },
      "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/metrics?from=-62147425&host=tempor Ut sed velit&tag_filter=env IN (staging,test) AND service:web",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "metrics"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Seconds since the Unix epoch."
            },
            {
              "key": "host",
              "value": "tempor Ut sed velit",
              "description": "Hostname for filtering the list of metrics returned.\nIf set, metrics retrieved are those with the corresponding hostname tag."
            },
            {
              "key": "tag_filter",
              "value": "env IN (staging,test) AND service:web",
              "description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCannot be combined with other filters."
            }
          ]
        }
      },
      "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/metrics?from=-62147425&host=tempor Ut sed velit&tag_filter=env IN (staging,test) AND service:web",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "metrics"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Seconds since the Unix epoch."
            },
            {
              "key": "host",
              "value": "tempor Ut sed velit",
              "description": "Hostname for filtering the list of metrics returned.\nIf set, metrics retrieved are those with the corresponding hostname tag."
            },
            {
              "key": "tag_filter",
              "value": "env IN (staging,test) AND service:web",
              "description": "Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.\nCannot be combined with other filters."
            }
          ]
        }
      },
      "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}"
    }
  ]
}