Chilkat Online Tools

TCL / Datadog API Collection / Get active metrics list

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateInt $queryParams "from" -62147425
CkJsonObject_UpdateString $queryParams "host" "tempor Ut sed velit"
CkJsonObject_UpdateString $queryParams "tag_filter" "env IN (staging,test) AND service:web"

CkHttp_SetRequestHeader $http "Accept" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.app.ddog-gov.com/api/v1/metrics" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set from [CkJsonObject_stringOf $jResp "from"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "metrics"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "metrics[i]"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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}"
    }
  ]
}