SQL Server / Datadog API Collection / Tag Configuration Cardinality Estimator
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'filter[groups]', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'filter[hours_ago]', '<integer>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'filter[num_aggregations]', '<integer>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'filter[pct]', '<boolean>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'filter[timespan_h]', '<integer>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/estimate', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @Estimate_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Estimate_type OUT, 'data.attributes.estimate_type'
DECLARE @Estimated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Estimated_at OUT, 'data.attributes.estimated_at'
DECLARE @Estimated_output_series nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Estimated_output_series OUT, 'data.attributes.estimated_output_series'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data.id'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'data.type'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
