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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'start_hr', '1991-02-02T07:22:34.204Z'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'end_hr', '1991-02-02T07:22:34.204Z'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'usage_type', 'profiled_host_usage'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'next_record_id', 'tempor Ut sed velit'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'tag_breakdown_keys', 'tempor Ut sed velit'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'include_descendants', 'true'
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/hourly-attribution', @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
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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": {
-- "pagination": {
-- "next_record_id": "proident mollit"
-- }
-- },
-- "usage": [
-- {
-- "hour": "1986-01-17T07:37:35.170Z",
-- "org_name": "in labore reprehenderit in Exce",
-- "public_id": "minim deserunt dolor qui",
-- "region": "pariatur minim Lorem",
-- "tag_config_source": "ut adipisicing ut",
-- "tags": {
-- "anim__1a": [
-- "datadog-integrations-lab",
-- "datadog-integrations-lab"
-- ]
-- },
-- "total_usage_sum": -77225004.76702869,
-- "updated_at": "dolore ipsum cupidatat",
-- "usage_type": "snmp_usage"
-- },
-- {
-- "hour": "2007-03-17T08:17:32.448Z",
-- "org_name": "sint mollit ut et",
-- "public_id": "amet Excepteur officia",
-- "region": "proident",
-- "tag_config_source": "cillum",
-- "tags": {
-- "Duis_2": [
-- "datadog-integrations-lab",
-- "datadog-integrations-lab"
-- ]
-- },
-- "total_usage_sum": 57869801.725036174,
-- "updated_at": "ea in",
-- "usage_type": "api_usage"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @hour nvarchar(4000)
DECLARE @org_name nvarchar(4000)
DECLARE @public_id nvarchar(4000)
DECLARE @region nvarchar(4000)
DECLARE @tag_config_source nvarchar(4000)
DECLARE @total_usage_sum nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @usage_type nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @strVal nvarchar(4000)
DECLARE @Next_record_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Next_record_id OUT, 'metadata.pagination.next_record_id'
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, 'StringOf', @hour OUT, 'usage[i].hour'
EXEC sp_OAMethod @jResp, 'StringOf', @org_name OUT, 'usage[i].org_name'
EXEC sp_OAMethod @jResp, 'StringOf', @public_id OUT, 'usage[i].public_id'
EXEC sp_OAMethod @jResp, 'StringOf', @region OUT, 'usage[i].region'
EXEC sp_OAMethod @jResp, 'StringOf', @tag_config_source OUT, 'usage[i].tag_config_source'
EXEC sp_OAMethod @jResp, 'StringOf', @total_usage_sum OUT, 'usage[i].total_usage_sum'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'usage[i].updated_at'
EXEC sp_OAMethod @jResp, 'StringOf', @usage_type OUT, 'usage[i].usage_type'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'usage[i].tags.anim__1a'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'usage[i].tags.anim__1a[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'usage[i].tags.Duis_2'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'usage[i].tags.Duis_2[j]'
SELECT @j = @j + 1
END
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 "start_hr=1991-02-02T07%3A22%3A34.204Z"
-d "end_hr=1991-02-02T07%3A22%3A34.204Z"
-d "usage_type=profiled_host_usage"
-d "next_record_id=tempor%20Ut%20sed%20velit"
-d "tag_breakdown_keys=tempor%20Ut%20sed%20velit"
-d "include_descendants=true"
-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v1/usage/hourly-attribution
Postman Collection Item JSON
{
"name": "Get hourly usage attribution",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/hourly-attribution?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&usage_type=profiled_host_usage&next_record_id=tempor Ut sed velit&tag_breakdown_keys=tempor Ut sed velit&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hourly-attribution"
],
"query": [
{
"key": "start_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
},
{
"key": "usage_type",
"value": "profiled_host_usage",
"description": "(Required) Usage type to retrieve."
},
{
"key": "next_record_id",
"value": "tempor Ut sed velit",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "tag_breakdown_keys",
"value": "tempor Ut sed velit",
"description": "Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
},
"description": "Get hourly usage attribution. Multi-region data is available starting March 1, 2023.\n\nThis API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is\nset in the response. If it is, make another request and pass `next_record_id` as a parameter.\nPseudo code example:\n\n```\nresponse := GetHourlyUsageAttribution(start_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\n sleep(5 seconds) # Avoid running into rate limit\n response := GetHourlyUsageAttribution(start_month, next_record_id=cursor)\n cursor := response.metadata.pagination.next_record_id\nEND\n```"
},
"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/hourly-attribution?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&usage_type=profiled_host_usage&next_record_id=tempor Ut sed velit&tag_breakdown_keys=tempor Ut sed velit&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hourly-attribution"
],
"query": [
{
"key": "start_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
},
{
"key": "usage_type",
"value": "profiled_host_usage",
"description": "(Required) Usage type to retrieve."
},
{
"key": "next_record_id",
"value": "tempor Ut sed velit",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "tag_breakdown_keys",
"value": "tempor Ut sed velit",
"description": "Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [
],
"body": "{\n \"metadata\": {\n \"pagination\": {\n \"next_record_id\": \"proident mollit\"\n }\n },\n \"usage\": [\n {\n \"hour\": \"1986-01-17T07:37:35.170Z\",\n \"org_name\": \"in labore reprehenderit in Exce\",\n \"public_id\": \"minim deserunt dolor qui\",\n \"region\": \"pariatur minim Lorem\",\n \"tag_config_source\": \"ut adipisicing ut\",\n \"tags\": {\n \"anim__1a\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ]\n },\n \"total_usage_sum\": -77225004.76702869,\n \"updated_at\": \"dolore ipsum cupidatat\",\n \"usage_type\": \"snmp_usage\"\n },\n {\n \"hour\": \"2007-03-17T08:17:32.448Z\",\n \"org_name\": \"sint mollit ut et\",\n \"public_id\": \"amet Excepteur officia\",\n \"region\": \"proident\",\n \"tag_config_source\": \"cillum\",\n \"tags\": {\n \"Duis_2\": [\n \"datadog-integrations-lab\",\n \"datadog-integrations-lab\"\n ]\n },\n \"total_usage_sum\": 57869801.725036174,\n \"updated_at\": \"ea in\",\n \"usage_type\": \"api_usage\"\n }\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/hourly-attribution?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&usage_type=profiled_host_usage&next_record_id=tempor Ut sed velit&tag_breakdown_keys=tempor Ut sed velit&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hourly-attribution"
],
"query": [
{
"key": "start_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
},
{
"key": "usage_type",
"value": "profiled_host_usage",
"description": "(Required) Usage type to retrieve."
},
{
"key": "next_record_id",
"value": "tempor Ut sed velit",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "tag_breakdown_keys",
"value": "tempor Ut sed velit",
"description": "Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
}
},
"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/hourly-attribution?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&usage_type=profiled_host_usage&next_record_id=tempor Ut sed velit&tag_breakdown_keys=tempor Ut sed velit&include_descendants=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hourly-attribution"
],
"query": [
{
"key": "start_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
},
{
"key": "usage_type",
"value": "profiled_host_usage",
"description": "(Required) Usage type to retrieve."
},
{
"key": "next_record_id",
"value": "tempor Ut sed velit",
"description": "List following results with a next_record_id provided in the previous query."
},
{
"key": "tag_breakdown_keys",
"value": "tempor Ut sed velit",
"description": "Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags.\n\nTo see which tags are available, look for the value of `tag_config_source` in the API response."
},
{
"key": "include_descendants",
"value": "true",
"description": "Include child org usage in the response. Defaults to `true`."
}
]
}
},
"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}"
}
]
}
