PureBasic / Datadog API Collection / Get hourly usage for hosts and containers
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"start_hr","1991-02-02T07:22:34.204Z")
CkJsonObject::ckUpdateString(queryParams,"end_hr","1991-02-02T07:22:34.204Z")
CkHttp::ckSetRequestHeader(http,"Accept","application/json;datetime-format=rfc3339")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.app.ddog-gov.com/api/v1/usage/hosts",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "usage": [
; {
; "agent_host_count": 73441781,
; "alibaba_host_count": 90401508,
; "apm_azure_app_service_host_count": -86849264,
; "apm_host_count": 82769044,
; "aws_host_count": 14539535,
; "azure_host_count": 2961184,
; "container_count": 98523302,
; "gcp_host_count": -58899544,
; "heroku_host_count": -59373102,
; "host_count": -77148345,
; "hour": "1983-07-20T14:45:29.119Z",
; "infra_azure_app_service": 51619587,
; "opentelemetry_apm_host_count": 17751454,
; "opentelemetry_host_count": 76877077,
; "org_name": "incididunt eiusmod veniam",
; "public_id": "cupidatat officia",
; "vsphere_host_count": -81797713
; },
; {
; "agent_host_count": 38112848,
; "alibaba_host_count": 63494534,
; "apm_azure_app_service_host_count": 51846293,
; "apm_host_count": 87787743,
; "aws_host_count": 67240241,
; "azure_host_count": -72169913,
; "container_count": 15638104,
; "gcp_host_count": 69594500,
; "heroku_host_count": 48641450,
; "host_count": -78289977,
; "hour": "1992-06-10T12:42:23.102Z",
; "infra_azure_app_service": -33630613,
; "opentelemetry_apm_host_count": 51094183,
; "opentelemetry_host_count": 54526263,
; "org_name": "laborum cillum",
; "public_id": "culpa incididunt qui do",
; "vsphere_host_count": -8217961
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
agent_host_count.i
alibaba_host_count.i
apm_azure_app_service_host_count.i
apm_host_count.i
aws_host_count.i
azure_host_count.i
container_count.i
gcp_host_count.i
heroku_host_count.i
host_count.i
hour.s
infra_azure_app_service.i
opentelemetry_apm_host_count.i
opentelemetry_host_count.i
org_name.s
public_id.s
vsphere_host_count.i
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"usage")
While i < count_i
CkJsonObject::setCkI(jResp, i)
agent_host_count = CkJsonObject::ckIntOf(jResp,"usage[i].agent_host_count")
alibaba_host_count = CkJsonObject::ckIntOf(jResp,"usage[i].alibaba_host_count")
apm_azure_app_service_host_count = CkJsonObject::ckIntOf(jResp,"usage[i].apm_azure_app_service_host_count")
apm_host_count = CkJsonObject::ckIntOf(jResp,"usage[i].apm_host_count")
aws_host_count = CkJsonObject::ckIntOf(jResp,"usage[i].aws_host_count")
azure_host_count = CkJsonObject::ckIntOf(jResp,"usage[i].azure_host_count")
container_count = CkJsonObject::ckIntOf(jResp,"usage[i].container_count")
gcp_host_count = CkJsonObject::ckIntOf(jResp,"usage[i].gcp_host_count")
heroku_host_count = CkJsonObject::ckIntOf(jResp,"usage[i].heroku_host_count")
host_count = CkJsonObject::ckIntOf(jResp,"usage[i].host_count")
hour = CkJsonObject::ckStringOf(jResp,"usage[i].hour")
infra_azure_app_service = CkJsonObject::ckIntOf(jResp,"usage[i].infra_azure_app_service")
opentelemetry_apm_host_count = CkJsonObject::ckIntOf(jResp,"usage[i].opentelemetry_apm_host_count")
opentelemetry_host_count = CkJsonObject::ckIntOf(jResp,"usage[i].opentelemetry_host_count")
org_name = CkJsonObject::ckStringOf(jResp,"usage[i].org_name")
public_id = CkJsonObject::ckStringOf(jResp,"usage[i].public_id")
vsphere_host_count = CkJsonObject::ckIntOf(jResp,"usage[i].vsphere_host_count")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "start_hr=1991-02-02T07%3A22%3A34.204Z"
-d "end_hr=1991-02-02T07%3A22%3A34.204Z"
-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v1/usage/hosts
Postman Collection Item JSON
{
"name": "Get hourly usage for hosts and containers",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/hosts?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hosts"
],
"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 **before** this hour."
}
]
},
"description": "Get hourly usage for hosts and containers.\n**Note:** hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide."
},
"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/hosts?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hosts"
],
"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 **before** this hour."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [
],
"body": "{\n \"usage\": [\n {\n \"agent_host_count\": 73441781,\n \"alibaba_host_count\": 90401508,\n \"apm_azure_app_service_host_count\": -86849264,\n \"apm_host_count\": 82769044,\n \"aws_host_count\": 14539535,\n \"azure_host_count\": 2961184,\n \"container_count\": 98523302,\n \"gcp_host_count\": -58899544,\n \"heroku_host_count\": -59373102,\n \"host_count\": -77148345,\n \"hour\": \"1983-07-20T14:45:29.119Z\",\n \"infra_azure_app_service\": 51619587,\n \"opentelemetry_apm_host_count\": 17751454,\n \"opentelemetry_host_count\": 76877077,\n \"org_name\": \"incididunt eiusmod veniam\",\n \"public_id\": \"cupidatat officia\",\n \"vsphere_host_count\": -81797713\n },\n {\n \"agent_host_count\": 38112848,\n \"alibaba_host_count\": 63494534,\n \"apm_azure_app_service_host_count\": 51846293,\n \"apm_host_count\": 87787743,\n \"aws_host_count\": 67240241,\n \"azure_host_count\": -72169913,\n \"container_count\": 15638104,\n \"gcp_host_count\": 69594500,\n \"heroku_host_count\": 48641450,\n \"host_count\": -78289977,\n \"hour\": \"1992-06-10T12:42:23.102Z\",\n \"infra_azure_app_service\": -33630613,\n \"opentelemetry_apm_host_count\": 51094183,\n \"opentelemetry_host_count\": 54526263,\n \"org_name\": \"laborum cillum\",\n \"public_id\": \"culpa incididunt qui do\",\n \"vsphere_host_count\": -8217961\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/hosts?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hosts"
],
"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 **before** this hour."
}
]
}
},
"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/hosts?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hosts"
],
"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 **before** this hour."
}
]
}
},
"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/hosts?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"hosts"
],
"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 **before** this hour."
}
]
}
},
"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}"
}
]
}
