Chilkat Online Tools

PureBasic / Datadog API Collection / Get active metrics list

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    queryParams.i = CkJsonObject::ckCreate()
    If queryParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateInt(queryParams,"from",-62147425)
    CkJsonObject::ckUpdateString(queryParams,"host","tempor Ut sed velit")
    CkJsonObject::ckUpdateString(queryParams,"tag_filter","env IN (staging,test) AND service:web")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.app.ddog-gov.com/api/v1/metrics",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(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

    strVal.s

    from.s = CkJsonObject::ckStringOf(jResp,"from")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"metrics")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"metrics[i]")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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