Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_V_type
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_QueryParams.UpdateString("filter[configured]","<boolean>")
loo_QueryParams.UpdateString("filter[tags_configured]","<string>")
loo_QueryParams.UpdateString("filter[metric_type]","gauge")
loo_QueryParams.UpdateString("filter[include_percentiles]","<boolean>")
loo_QueryParams.UpdateString("filter[queried]","<boolean>")
loo_QueryParams.UpdateString("filter[tags]","<string>")
loo_QueryParams.UpdateString("window[seconds]","<long>")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/metrics",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
li_Count_i = loo_JResp.SizeOfArray("data")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("data[i].id")
ls_V_type = loo_JResp.StringOf("data[i].type")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
