Chilkat Online Tools

Powershell / Datadog API Collection / Tag Configuration Cardinality Estimator

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("filter[groups]","<string>")
$queryParams.UpdateString("filter[hours_ago]","<integer>")
$queryParams.UpdateString("filter[num_aggregations]","<integer>")
$queryParams.UpdateString("filter[pct]","<boolean>")
$queryParams.UpdateString("filter[timespan_h]","<integer>")

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

$resp = $http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/estimate",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

# 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

$Estimate_type = $jResp.StringOf("data.attributes.estimate_type")
$Estimated_at = $jResp.StringOf("data.attributes.estimated_at")
$Estimated_output_series = $jResp.StringOf("data.attributes.estimated_output_series")
$Id = $jResp.StringOf("data.id")
$v_Type = $jResp.StringOf("data.type")

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&trade;."
  },
  "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}"
    }
  ]
}