SQL Server / Datadog API Collection / Get all custom metrics by hourly average
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, 'month', '1991-02-02T07:22:34.204Z'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'day', '1991-02-02T07:22:34.204Z'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'names', 'dolor cillum in'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'names', 'proident'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'limit', 500
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'next_record_id', 'tempor Ut sed velit'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json;datetime-format=rfc3339'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.app.ddog-gov.com/api/v1/usage/top_avg_metrics', @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)
-- {
-- "metadata": {
-- "day": "1970-12-19T21:24:25.324Z",
-- "month": "1968-08-09T04:45:37.966Z",
-- "pagination": {
-- "limit": 93806394,
-- "next_record_id": "Lorem Excepteur culpa irure",
-- "total_number_of_records": 92367782
-- }
-- },
-- "usage": [
-- {
-- "avg_metric_hour": 6012044,
-- "max_metric_hour": 51959196,
-- "metric_category": "standard",
-- "metric_name": "nisi in"
-- },
-- {
-- "avg_metric_hour": -65971160,
-- "max_metric_hour": 62447032,
-- "metric_category": "custom",
-- "metric_name": "magna sed proident labore"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @avg_metric_hour int
DECLARE @max_metric_hour int
DECLARE @metric_category nvarchar(4000)
DECLARE @metric_name nvarchar(4000)
DECLARE @Day nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Day OUT, 'metadata.day'
DECLARE @Month nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Month OUT, 'metadata.month'
DECLARE @Limit int
EXEC sp_OAMethod @jResp, 'IntOf', @Limit OUT, 'metadata.pagination.limit'
DECLARE @Next_record_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Next_record_id OUT, 'metadata.pagination.next_record_id'
DECLARE @Total_number_of_records int
EXEC sp_OAMethod @jResp, 'IntOf', @Total_number_of_records OUT, 'metadata.pagination.total_number_of_records'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'usage'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'IntOf', @avg_metric_hour OUT, 'usage[i].avg_metric_hour'
EXEC sp_OAMethod @jResp, 'IntOf', @max_metric_hour OUT, 'usage[i].max_metric_hour'
EXEC sp_OAMethod @jResp, 'StringOf', @metric_category OUT, 'usage[i].metric_category'
EXEC sp_OAMethod @jResp, 'StringOf', @metric_name OUT, 'usage[i].metric_name'
SELECT @i = @i + 1
END
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 "month=1991-02-02T07%3A22%3A34.204Z"
-d "day=1991-02-02T07%3A22%3A34.204Z"
-d "names=dolor%20cillum%20in"
-d "names=proident"
-d "limit=500"
-d "next_record_id=tempor%20Ut%20sed%20velit"
-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v1/usage/top_avg_metrics
Postman Collection Item JSON
{
"name": "Get all custom metrics by hourly average",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/top_avg_metrics?month=1991-02-02T07:22:34.204Z&day=1991-02-02T07:22:34.204Z&names=dolor cillum in&names=proident&limit=500&next_record_id=tempor Ut sed velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"top_avg_metrics"
],
"query": [
{
"key": "month",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "day",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "names",
"value": "dolor cillum in",
"description": "Comma-separated list of metric names."
},
{
"key": "names",
"value": "proident",
"description": "Comma-separated list of metric names."
},
{
"key": "limit",
"value": "500",
"description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
},
{
"key": "next_record_id",
"value": "tempor Ut sed velit",
"description": "List following results with a next_record_id provided in the previous query."
}
]
},
"description": "Get all [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) by hourly average. Use the month parameter to get a month-to-date data resolution or use the day parameter to get a daily resolution. One of the two is required, and only one of the two is allowed."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/top_avg_metrics?month=1991-02-02T07:22:34.204Z&day=1991-02-02T07:22:34.204Z&names=proident&limit=500&next_record_id=tempor Ut sed velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"top_avg_metrics"
],
"query": [
{
"key": "month",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "day",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "names",
"value": "proident",
"description": "Comma-separated list of metric names."
},
{
"key": "limit",
"value": "500",
"description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
},
{
"key": "next_record_id",
"value": "tempor Ut sed velit",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [
],
"body": "{\n \"metadata\": {\n \"day\": \"1970-12-19T21:24:25.324Z\",\n \"month\": \"1968-08-09T04:45:37.966Z\",\n \"pagination\": {\n \"limit\": 93806394,\n \"next_record_id\": \"Lorem Excepteur culpa irure\",\n \"total_number_of_records\": 92367782\n }\n },\n \"usage\": [\n {\n \"avg_metric_hour\": 6012044,\n \"max_metric_hour\": 51959196,\n \"metric_category\": \"standard\",\n \"metric_name\": \"nisi in\"\n },\n {\n \"avg_metric_hour\": -65971160,\n \"max_metric_hour\": 62447032,\n \"metric_category\": \"custom\",\n \"metric_name\": \"magna sed proident labore\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/top_avg_metrics?month=1991-02-02T07:22:34.204Z&day=1991-02-02T07:22:34.204Z&names=proident&limit=500&next_record_id=tempor Ut sed velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"top_avg_metrics"
],
"query": [
{
"key": "month",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "day",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "names",
"value": "proident",
"description": "Comma-separated list of metric names."
},
{
"key": "limit",
"value": "500",
"description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
},
{
"key": "next_record_id",
"value": "tempor Ut sed velit",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden - User is not authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/top_avg_metrics?month=1991-02-02T07:22:34.204Z&day=1991-02-02T07:22:34.204Z&names=proident&limit=500&next_record_id=tempor Ut sed velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"top_avg_metrics"
],
"query": [
{
"key": "month",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "day",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "names",
"value": "proident",
"description": "Comma-separated list of metric names."
},
{
"key": "limit",
"value": "500",
"description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
},
{
"key": "next_record_id",
"value": "tempor Ut sed velit",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"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;datetime-format=rfc3339"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/top_avg_metrics?month=1991-02-02T07:22:34.204Z&day=1991-02-02T07:22:34.204Z&names=proident&limit=500&next_record_id=tempor Ut sed velit",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"top_avg_metrics"
],
"query": [
{
"key": "month",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "day",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
},
{
"key": "names",
"value": "proident",
"description": "Comma-separated list of metric names."
},
{
"key": "limit",
"value": "500",
"description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
},
{
"key": "next_record_id",
"value": "tempor Ut sed velit",
"description": "List following results with a next_record_id provided in the previous query."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}