Chilkat Online Tools

Ruby / Datadog API Collection / Get hourly usage for hosts and containers

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("start_hr","1991-02-02T07:22:34.204Z")
queryParams.UpdateString("end_hr","1991-02-02T07:22:34.204Z")

http.SetRequestHeader("Accept","application/json;datetime-format=rfc3339")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/usage/hosts",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

i = 0
count_i = jResp.SizeOfArray("usage")
while i < count_i
    jResp.put_I(i)
    agent_host_count = jResp.IntOf("usage[i].agent_host_count")
    alibaba_host_count = jResp.IntOf("usage[i].alibaba_host_count")
    apm_azure_app_service_host_count = jResp.IntOf("usage[i].apm_azure_app_service_host_count")
    apm_host_count = jResp.IntOf("usage[i].apm_host_count")
    aws_host_count = jResp.IntOf("usage[i].aws_host_count")
    azure_host_count = jResp.IntOf("usage[i].azure_host_count")
    container_count = jResp.IntOf("usage[i].container_count")
    gcp_host_count = jResp.IntOf("usage[i].gcp_host_count")
    heroku_host_count = jResp.IntOf("usage[i].heroku_host_count")
    host_count = jResp.IntOf("usage[i].host_count")
    hour = jResp.stringOf("usage[i].hour")
    infra_azure_app_service = jResp.IntOf("usage[i].infra_azure_app_service")
    opentelemetry_apm_host_count = jResp.IntOf("usage[i].opentelemetry_apm_host_count")
    opentelemetry_host_count = jResp.IntOf("usage[i].opentelemetry_host_count")
    org_name = jResp.stringOf("usage[i].org_name")
    public_id = jResp.stringOf("usage[i].public_id")
    vsphere_host_count = jResp.IntOf("usage[i].vsphere_host_count")
    i = i + 1
end

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}"
    }
  ]
}