Chilkat Online Tools

autoit / Datadog API Collection / Get hourly usage for CSPM

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat_9_5_0.JsonObject")
$oQueryParams.UpdateString("start_hr","1991-02-02T07:22:34.204Z")
$oQueryParams.UpdateString("end_hr","1991-02-02T07:22:34.204Z")

$oHttp.SetRequestHeader "Accept","application/json;datetime-format=rfc3339"

Local $oResp = $oHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/usage/cspm",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "usage": [
;     {
;       "aas_host_count": -80766489.56845878,
;       "aws_host_count": 17971624.141541034,
;       "azure_host_count": -63389392.498256706,
;       "compliance_host_count": -36217158.04911183,
;       "container_count": 11133759.007289752,
;       "gcp_host_count": 50901682.36994678,
;       "host_count": -47780028.372240715,
;       "hour": "2018-03-17T20:30:04.637Z",
;       "org_name": "mollit",
;       "public_id": "laborum aliqua ex irure"
;     },
;     {
;       "aas_host_count": -98211553.22625725,
;       "aws_host_count": -72710141.40577123,
;       "azure_host_count": 57237415.532838285,
;       "compliance_host_count": 955332.3425777704,
;       "container_count": -47480535.50305298,
;       "gcp_host_count": -39047011.60659756,
;       "host_count": 61940711.68366918,
;       "hour": "2009-11-04T13:20:03.152Z",
;       "org_name": "mollit adipisicing velit",
;       "public_id": "officia amet do in"
;     }
;   ]
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sAas_host_count
Local $sAws_host_count
Local $sAzure_host_count
Local $sCompliance_host_count
Local $sContainer_count
Local $sGcp_host_count
Local $sHost_count
Local $sHour
Local $sOrg_name
Local $sPublic_id

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("usage")
While $i < $iCount_i
    $oJResp.I = $i
    $sAas_host_count = $oJResp.StringOf("usage[i].aas_host_count")
    $sAws_host_count = $oJResp.StringOf("usage[i].aws_host_count")
    $sAzure_host_count = $oJResp.StringOf("usage[i].azure_host_count")
    $sCompliance_host_count = $oJResp.StringOf("usage[i].compliance_host_count")
    $sContainer_count = $oJResp.StringOf("usage[i].container_count")
    $sGcp_host_count = $oJResp.StringOf("usage[i].gcp_host_count")
    $sHost_count = $oJResp.StringOf("usage[i].host_count")
    $sHour = $oJResp.StringOf("usage[i].hour")
    $sOrg_name = $oJResp.StringOf("usage[i].org_name")
    $sPublic_id = $oJResp.StringOf("usage[i].public_id")
    $i = $i + 1
Wend

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/cspm

Postman Collection Item JSON

{
  "name": "Get hourly usage for CSPM",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json;datetime-format=rfc3339"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/usage/cspm?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "usage",
        "cspm"
      ],
      "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."
        }
      ]
    },
    "description": "Get hourly usage for cloud security posture management (CSPM).\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/cspm?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "cspm"
          ],
          "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."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json;datetime-format=rfc3339"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"usage\": [\n    {\n      \"aas_host_count\": -80766489.56845878,\n      \"aws_host_count\": 17971624.141541034,\n      \"azure_host_count\": -63389392.498256706,\n      \"compliance_host_count\": -36217158.04911183,\n      \"container_count\": 11133759.007289752,\n      \"gcp_host_count\": 50901682.36994678,\n      \"host_count\": -47780028.372240715,\n      \"hour\": \"2018-03-17T20:30:04.637Z\",\n      \"org_name\": \"mollit\",\n      \"public_id\": \"laborum aliqua ex irure\"\n    },\n    {\n      \"aas_host_count\": -98211553.22625725,\n      \"aws_host_count\": -72710141.40577123,\n      \"azure_host_count\": 57237415.532838285,\n      \"compliance_host_count\": 955332.3425777704,\n      \"container_count\": -47480535.50305298,\n      \"gcp_host_count\": -39047011.60659756,\n      \"host_count\": 61940711.68366918,\n      \"hour\": \"2009-11-04T13:20:03.152Z\",\n      \"org_name\": \"mollit adipisicing velit\",\n      \"public_id\": \"officia amet do in\"\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/cspm?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "cspm"
          ],
          "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."
            }
          ]
        }
      },
      "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/cspm?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "cspm"
          ],
          "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."
            }
          ]
        }
      },
      "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/cspm?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "cspm"
          ],
          "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."
            }
          ]
        }
      },
      "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}"
    }
  ]
}