Chilkat Online Tools

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

Back to Collection Items

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

loHttp = createobject("CkHttp")

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("start_hr","<dateTime>")
loQueryParams.UpdateString("end_hr","<dateTime>")

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

loResp = loHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/usage/application_security",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loQueryParams
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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
lnCount_i = loJResp.SizeOfArray("data")
do while i < lnCount_i
    loJResp.I = i
    lcOrg_name = loJResp.StringOf("data[i].attributes.org_name")
    lcProduct_family = loJResp.StringOf("data[i].attributes.product_family")
    lcPublic_id = loJResp.StringOf("data[i].attributes.public_id")
    lcRegion = loJResp.StringOf("data[i].attributes.region")
    lcUsage_type = loJResp.StringOf("data[i].attributes.usage_type")
    lcId = loJResp.StringOf("data[i].id")
    lcV_type = loJResp.StringOf("data[i].type")
    j = 0
    lnCount_j = loJResp.SizeOfArray("data[i].attributes.timeseries")
    do while j < lnCount_j
        loJResp.J = j
        lcTimestamp = loJResp.StringOf("data[i].attributes.timeseries[j].timestamp")
        lcValue = loJResp.StringOf("data[i].attributes.timeseries[j].value")
        j = j + 1
    enddo
    i = i + 1
enddo


release loHttp
release loQueryParams
release loSbResponseBody
release loJResp

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