Chilkat Online Tools

Ruby / Datadog API Collection / Get hourly usage for application security

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","<dateTime>")
queryParams.UpdateString("end_hr","<dateTime>")

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/usage/application_security",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)

# {
#   "data": [
#     {
#       "attributes": {
#         "org_name": "<string>",
#         "product_family": "<string>",
#         "public_id": "<string>",
#         "region": "<string>",
#         "timeseries": [
#           {
#             "timestamp": "<dateTime>",
#             "value": "<long>"
#           },
#           {
#             "timestamp": "<dateTime>",
#             "value": "<long>"
#           }
#         ],
#         "usage_type": "app_sec_host_count"
#       },
#       "id": "<string>",
#       "type": "usage_timeseries"
#     },
#     {
#       "attributes": {
#         "org_name": "<string>",
#         "product_family": "<string>",
#         "public_id": "<string>",
#         "region": "<string>",
#         "timeseries": [
#           {
#             "timestamp": "<dateTime>",
#             "value": "<long>"
#           },
#           {
#             "timestamp": "<dateTime>",
#             "value": "<long>"
#           }
#         ],
#         "usage_type": "lambda_traced_invocations_count"
#       },
#       "id": "<string>",
#       "type": "usage_timeseries"
#     }
#   ]
# }

# 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("data")
while i < count_i
    jResp.put_I(i)
    Org_name = jResp.stringOf("data[i].attributes.org_name")
    Product_family = jResp.stringOf("data[i].attributes.product_family")
    Public_id = jResp.stringOf("data[i].attributes.public_id")
    Region = jResp.stringOf("data[i].attributes.region")
    Usage_type = jResp.stringOf("data[i].attributes.usage_type")
    id = jResp.stringOf("data[i].id")
    v_type = jResp.stringOf("data[i].type")
    j = 0
    count_j = jResp.SizeOfArray("data[i].attributes.timeseries")
    while j < count_j
        jResp.put_J(j)
        timestamp = jResp.stringOf("data[i].attributes.timeseries[j].timestamp")
        value = jResp.stringOf("data[i].attributes.timeseries[j].value")
        j = j + 1
    end
    i = i + 1
end

Curl Command

curl -G -d "start_hr=%3CdateTime%3E"
	-d "end_hr=%3CdateTime%3E"
	-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v2/usage/application_security

Postman Collection Item JSON

{
  "name": "Get hourly usage for application security",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json;datetime-format=rfc3339"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/usage/application_security?start_hr=<dateTime>&end_hr=<dateTime>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "usage",
        "application_security"
      ],
      "query": [
        {
          "key": "start_hr",
          "value": "<dateTime>",
          "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
        },
        {
          "key": "end_hr",
          "value": "<dateTime>",
          "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
        }
      ]
    },
    "description": "Get hourly usage for application security .\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)"
  },
  "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/v2/usage/application_security?start_hr=<dateTime>&end_hr=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "application_security"
          ],
          "query": [
            {
              "key": "start_hr",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
            },
            {
              "key": "end_hr",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json;datetime-format=rfc3339"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"attributes\": {\n        \"org_name\": \"<string>\",\n        \"product_family\": \"<string>\",\n        \"public_id\": \"<string>\",\n        \"region\": \"<string>\",\n        \"timeseries\": [\n          {\n            \"timestamp\": \"<dateTime>\",\n            \"value\": \"<long>\"\n          },\n          {\n            \"timestamp\": \"<dateTime>\",\n            \"value\": \"<long>\"\n          }\n        ],\n        \"usage_type\": \"app_sec_host_count\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"usage_timeseries\"\n    },\n    {\n      \"attributes\": {\n        \"org_name\": \"<string>\",\n        \"product_family\": \"<string>\",\n        \"public_id\": \"<string>\",\n        \"region\": \"<string>\",\n        \"timeseries\": [\n          {\n            \"timestamp\": \"<dateTime>\",\n            \"value\": \"<long>\"\n          },\n          {\n            \"timestamp\": \"<dateTime>\",\n            \"value\": \"<long>\"\n          }\n        ],\n        \"usage_type\": \"lambda_traced_invocations_count\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"usage_timeseries\"\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/v2/usage/application_security?start_hr=<dateTime>&end_hr=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "application_security"
          ],
          "query": [
            {
              "key": "start_hr",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
            },
            {
              "key": "end_hr",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**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    \"<string>\",\n    \"<string>\"\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/v2/usage/application_security?start_hr=<dateTime>&end_hr=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "application_security"
          ],
          "query": [
            {
              "key": "start_hr",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
            },
            {
              "key": "end_hr",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**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    \"<string>\",\n    \"<string>\"\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/v2/usage/application_security?start_hr=<dateTime>&end_hr=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "application_security"
          ],
          "query": [
            {
              "key": "start_hr",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
            },
            {
              "key": "end_hr",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**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    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}