lianja / Datadog API Collection / Tag Configuration Cardinality Estimator
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("filter[groups]","<string>")
loQueryParams.UpdateString("filter[hours_ago]","<integer>")
loQueryParams.UpdateString("filter[num_aggregations]","<integer>")
loQueryParams.UpdateString("filter[pct]","<boolean>")
loQueryParams.UpdateString("filter[timespan_h]","<integer>")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/estimate",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "attributes": {
// "estimate_type": "count_or_gauge",
// "estimated_at": "<dateTime>",
// "estimated_output_series": "<long>"
// },
// "id": "<string>",
// "type": "metric_cardinality_estimate"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcEstimate_type = loJResp.StringOf("data.attributes.estimate_type")
lcEstimated_at = loJResp.StringOf("data.attributes.estimated_at")
lcEstimated_output_series = loJResp.StringOf("data.attributes.estimated_output_series")
lcId = loJResp.StringOf("data.id")
lcV_Type = loJResp.StringOf("data.type")
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
Curl Command
curl -G -d "filter[groups]=%3Cstring%3E"
-d "filter[hours_ago]=%3Cinteger%3E"
-d "filter[num_aggregations]=%3Cinteger%3E"
-d "filter[pct]=%3Cboolean%3E"
-d "filter[timespan_h]=%3Cinteger%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/estimate
Postman Collection Item JSON
{
"name": "Tag Configuration Cardinality Estimator",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/estimate?filter[groups]=<string>&filter[hours_ago]=<integer>&filter[num_aggregations]=<integer>&filter[pct]=<boolean>&filter[timespan_h]=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "<string>",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "<integer>",
"description": "The number of hours of look back (from now) to estimate cardinality with."
},
{
"key": "filter[num_aggregations]",
"value": "<integer>",
"description": "The number of aggregations that a `count`, `rate`, or `gauge` metric is configured to use. Max number of aggregation combos is 9."
},
{
"key": "filter[pct]",
"value": "<boolean>",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "<integer>",
"description": "A window, in hours, from the look back to estimate cardinality with."
}
],
"variable": [
{
"key": "metric_name",
"value": "<string>"
}
]
},
"description": "Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™."
},
"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/:metric_name/estimate?filter[groups]=<string>&filter[hours_ago]=<integer>&filter[num_aggregations]=<integer>&filter[pct]=<boolean>&filter[timespan_h]=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "<string>",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "<integer>",
"description": "The number of hours of look back (from now) to estimate cardinality with."
},
{
"key": "filter[num_aggregations]",
"value": "<integer>",
"description": "The number of aggregations that a `count`, `rate`, or `gauge` metric is configured to use. Max number of aggregation combos is 9."
},
{
"key": "filter[pct]",
"value": "<boolean>",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "<integer>",
"description": "A window, in hours, from the look back to estimate cardinality with."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"estimate_type\": \"count_or_gauge\",\n \"estimated_at\": \"<dateTime>\",\n \"estimated_output_series\": \"<long>\"\n },\n \"id\": \"<string>\",\n \"type\": \"metric_cardinality_estimate\"\n }\n}"
},
{
"name": "API error response.",
"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/:metric_name/estimate?filter[groups]=<string>&filter[hours_ago]=<integer>&filter[num_aggregations]=<integer>&filter[pct]=<boolean>&filter[timespan_h]=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "<string>",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "<integer>",
"description": "The number of hours of look back (from now) to estimate cardinality with."
},
{
"key": "filter[num_aggregations]",
"value": "<integer>",
"description": "The number of aggregations that a `count`, `rate`, or `gauge` metric is configured to use. Max number of aggregation combos is 9."
},
{
"key": "filter[pct]",
"value": "<boolean>",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "<integer>",
"description": "A window, in hours, from the look back to estimate cardinality with."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"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": "API error response.",
"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/:metric_name/estimate?filter[groups]=<string>&filter[hours_ago]=<integer>&filter[num_aggregations]=<integer>&filter[pct]=<boolean>&filter[timespan_h]=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "<string>",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "<integer>",
"description": "The number of hours of look back (from now) to estimate cardinality with."
},
{
"key": "filter[num_aggregations]",
"value": "<integer>",
"description": "The number of aggregations that a `count`, `rate`, or `gauge` metric is configured to use. Max number of aggregation combos is 9."
},
{
"key": "filter[pct]",
"value": "<boolean>",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "<integer>",
"description": "A window, in hours, from the look back to estimate cardinality with."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"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": "API error response.",
"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/:metric_name/estimate?filter[groups]=<string>&filter[hours_ago]=<integer>&filter[num_aggregations]=<integer>&filter[pct]=<boolean>&filter[timespan_h]=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "<string>",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "<integer>",
"description": "The number of hours of look back (from now) to estimate cardinality with."
},
{
"key": "filter[num_aggregations]",
"value": "<integer>",
"description": "The number of aggregations that a `count`, `rate`, or `gauge` metric is configured to use. Max number of aggregation combos is 9."
},
{
"key": "filter[pct]",
"value": "<boolean>",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "<integer>",
"description": "A window, in hours, from the look back to estimate cardinality with."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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/:metric_name/estimate?filter[groups]=<string>&filter[hours_ago]=<integer>&filter[num_aggregations]=<integer>&filter[pct]=<boolean>&filter[timespan_h]=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"estimate"
],
"query": [
{
"key": "filter[groups]",
"value": "<string>",
"description": "Filtered tag keys that the metric is configured to query with."
},
{
"key": "filter[hours_ago]",
"value": "<integer>",
"description": "The number of hours of look back (from now) to estimate cardinality with."
},
{
"key": "filter[num_aggregations]",
"value": "<integer>",
"description": "The number of aggregations that a `count`, `rate`, or `gauge` metric is configured to use. Max number of aggregation combos is 9."
},
{
"key": "filter[pct]",
"value": "<boolean>",
"description": "A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators."
},
{
"key": "filter[timespan_h]",
"value": "<integer>",
"description": "A window, in hours, from the look back to estimate cardinality with."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"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}"
}
]
}
