Chilkat Online Tools

VB6 / Datadog API Collection / Get hourly usage by product family

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("filter[timestamp][start]","<dateTime>")
success = queryParams.UpdateString("filter[timestamp][end]","<dateTime>")
success = queryParams.UpdateString("filter[product_families]","<string>")
success = queryParams.UpdateString("filter[include_descendants]","false")
success = queryParams.UpdateString("filter[include_breakdown]","false")
success = queryParams.UpdateString("filter[versions]","<string>")
success = queryParams.UpdateInt("page[limit]",500)
success = queryParams.UpdateString("page[next_record_id]","<string>")

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

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/usage/hourly_usage",queryParams)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

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

' {
'   "data": [
'     {
'       "attributes": {
'         "measurements": [
'           {
'             "usage_type": "<string>",
'             "value": "<long>"
'           },
'           {
'             "usage_type": "<string>",
'             "value": "<long>"
'           }
'         ],
'         "org_name": "<string>",
'         "product_family": "<string>",
'         "public_id": "<string>",
'         "region": "<string>",
'         "timestamp": "<dateTime>"
'       },
'       "id": "<string>",
'       "type": "usage_timeseries"
'     },
'     {
'       "attributes": {
'         "measurements": [
'           {
'             "usage_type": "<string>",
'             "value": "<long>"
'           },
'           {
'             "usage_type": "<string>",
'             "value": "<long>"
'           }
'         ],
'         "org_name": "<string>",
'         "product_family": "<string>",
'         "public_id": "<string>",
'         "region": "<string>",
'         "timestamp": "<dateTime>"
'       },
'       "id": "<string>",
'       "type": "usage_timeseries"
'     }
'   ],
'   "meta": {
'     "pagination": {
'       "next_record_id": "<string>"
'     }
'   }
' }

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

Dim Org_name As String
Dim Product_family As String
Dim Public_id As String
Dim Region As String
Dim Timestamp As String
Dim id As String
Dim v_type As String
Dim j As Long
Dim count_j As Long
Dim usage_type As String
Dim value As String

Dim Next_record_id As String
Next_record_id = jResp.StringOf("meta.pagination.next_record_id")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data")
Do While i < count_i
    jResp.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")
    Timestamp = jResp.StringOf("data[i].attributes.timestamp")
    id = jResp.StringOf("data[i].id")
    v_type = jResp.StringOf("data[i].type")
    j = 0
    count_j = jResp.SizeOfArray("data[i].attributes.measurements")
    Do While j < count_j
        jResp.J = j
        usage_type = jResp.StringOf("data[i].attributes.measurements[j].usage_type")
        value = jResp.StringOf("data[i].attributes.measurements[j].value")
        j = j + 1
    Loop
    i = i + 1
Loop

Curl Command

curl -G -d "filter[timestamp][start]=%3CdateTime%3E"
	-d "filter[timestamp][end]=%3CdateTime%3E"
	-d "filter[product_families]=%3Cstring%3E"
	-d "filter[include_descendants]=false"
	-d "filter[include_breakdown]=false"
	-d "filter[versions]=%3Cstring%3E"
	-d "page[limit]=500"
	-d "page[next_record_id]=%3Cstring%3E"
	-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v2/usage/hourly_usage

Postman Collection Item JSON

{
  "name": "Get hourly usage by product family",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json;datetime-format=rfc3339"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/usage/hourly_usage?filter[timestamp][start]=<dateTime>&filter[timestamp][end]=<dateTime>&filter[product_families]=<string>&filter[include_descendants]=false&filter[include_breakdown]=false&filter[versions]=<string>&page[limit]=500&page[next_record_id]=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "usage",
        "hourly_usage"
      ],
      "query": [
        {
          "key": "filter[timestamp][start]",
          "value": "<dateTime>",
          "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
        },
        {
          "key": "filter[timestamp][end]",
          "value": "<dateTime>",
          "description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
        },
        {
          "key": "filter[product_families]",
          "value": "<string>",
          "description": "(Required) Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`,\n`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,\n`cspm`, `custom_events`, `cws`, `dbm`, `fargate`,\n`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`,\n`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `observability_pipelines`,\n`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`, `sds`, `snmp`,\n`synthetics_api`, `synthetics_browser`, `synthetics_parallel_testing`, and `timeseries`.\nThe following product family has been **deprecated**: `audit_logs`."
        },
        {
          "key": "filter[include_descendants]",
          "value": "false",
          "description": "Include child org usage in the response. Defaults to false."
        },
        {
          "key": "filter[include_breakdown]",
          "value": "false",
          "description": "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false."
        },
        {
          "key": "filter[versions]",
          "value": "<string>",
          "description": "Comma separated list of product family versions to use in the format `product_family:version`. For example,\n`infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested\nproduct family. Currently all families have one version `1.0.0`."
        },
        {
          "key": "page[limit]",
          "value": "500",
          "description": "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified."
        },
        {
          "key": "page[next_record_id]",
          "value": "<string>",
          "description": "List following results with a next_record_id provided in the previous query."
        }
      ]
    },
    "description": "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/hourly_usage?filter[timestamp][start]=<dateTime>&filter[timestamp][end]=<dateTime>&filter[product_families]=<string>&filter[include_descendants]=false&filter[include_breakdown]=false&filter[versions]=<string>&page[limit]=500&page[next_record_id]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "hourly_usage"
          ],
          "query": [
            {
              "key": "filter[timestamp][start]",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
            },
            {
              "key": "filter[timestamp][end]",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
            },
            {
              "key": "filter[product_families]",
              "value": "<string>",
              "description": "(Required) Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`,\n`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,\n`cspm`, `custom_events`, `cws`, `dbm`, `fargate`,\n`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`,\n`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `observability_pipelines`,\n`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`, `sds`, `snmp`,\n`synthetics_api`, `synthetics_browser`, `synthetics_parallel_testing`, and `timeseries`.\nThe following product family has been **deprecated**: `audit_logs`."
            },
            {
              "key": "filter[include_descendants]",
              "value": "false",
              "description": "Include child org usage in the response. Defaults to false."
            },
            {
              "key": "filter[include_breakdown]",
              "value": "false",
              "description": "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false."
            },
            {
              "key": "filter[versions]",
              "value": "<string>",
              "description": "Comma separated list of product family versions to use in the format `product_family:version`. For example,\n`infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested\nproduct family. Currently all families have one version `1.0.0`."
            },
            {
              "key": "page[limit]",
              "value": "500",
              "description": "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified."
            },
            {
              "key": "page[next_record_id]",
              "value": "<string>",
              "description": "List following results with a next_record_id provided in the previous query."
            }
          ]
        }
      },
      "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        \"measurements\": [\n          {\n            \"usage_type\": \"<string>\",\n            \"value\": \"<long>\"\n          },\n          {\n            \"usage_type\": \"<string>\",\n            \"value\": \"<long>\"\n          }\n        ],\n        \"org_name\": \"<string>\",\n        \"product_family\": \"<string>\",\n        \"public_id\": \"<string>\",\n        \"region\": \"<string>\",\n        \"timestamp\": \"<dateTime>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"usage_timeseries\"\n    },\n    {\n      \"attributes\": {\n        \"measurements\": [\n          {\n            \"usage_type\": \"<string>\",\n            \"value\": \"<long>\"\n          },\n          {\n            \"usage_type\": \"<string>\",\n            \"value\": \"<long>\"\n          }\n        ],\n        \"org_name\": \"<string>\",\n        \"product_family\": \"<string>\",\n        \"public_id\": \"<string>\",\n        \"region\": \"<string>\",\n        \"timestamp\": \"<dateTime>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"usage_timeseries\"\n    }\n  ],\n  \"meta\": {\n    \"pagination\": {\n      \"next_record_id\": \"<string>\"\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/hourly_usage?filter[timestamp][start]=<dateTime>&filter[timestamp][end]=<dateTime>&filter[product_families]=<string>&filter[include_descendants]=false&filter[include_breakdown]=false&filter[versions]=<string>&page[limit]=500&page[next_record_id]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "hourly_usage"
          ],
          "query": [
            {
              "key": "filter[timestamp][start]",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
            },
            {
              "key": "filter[timestamp][end]",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
            },
            {
              "key": "filter[product_families]",
              "value": "<string>",
              "description": "(Required) Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`,\n`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,\n`cspm`, `custom_events`, `cws`, `dbm`, `fargate`,\n`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`,\n`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `observability_pipelines`,\n`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`, `sds`, `snmp`,\n`synthetics_api`, `synthetics_browser`, `synthetics_parallel_testing`, and `timeseries`.\nThe following product family has been **deprecated**: `audit_logs`."
            },
            {
              "key": "filter[include_descendants]",
              "value": "false",
              "description": "Include child org usage in the response. Defaults to false."
            },
            {
              "key": "filter[include_breakdown]",
              "value": "false",
              "description": "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false."
            },
            {
              "key": "filter[versions]",
              "value": "<string>",
              "description": "Comma separated list of product family versions to use in the format `product_family:version`. For example,\n`infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested\nproduct family. Currently all families have one version `1.0.0`."
            },
            {
              "key": "page[limit]",
              "value": "500",
              "description": "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified."
            },
            {
              "key": "page[next_record_id]",
              "value": "<string>",
              "description": "List following results with a next_record_id provided in the previous query."
            }
          ]
        }
      },
      "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/hourly_usage?filter[timestamp][start]=<dateTime>&filter[timestamp][end]=<dateTime>&filter[product_families]=<string>&filter[include_descendants]=false&filter[include_breakdown]=false&filter[versions]=<string>&page[limit]=500&page[next_record_id]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "hourly_usage"
          ],
          "query": [
            {
              "key": "filter[timestamp][start]",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
            },
            {
              "key": "filter[timestamp][end]",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
            },
            {
              "key": "filter[product_families]",
              "value": "<string>",
              "description": "(Required) Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`,\n`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,\n`cspm`, `custom_events`, `cws`, `dbm`, `fargate`,\n`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`,\n`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `observability_pipelines`,\n`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`, `sds`, `snmp`,\n`synthetics_api`, `synthetics_browser`, `synthetics_parallel_testing`, and `timeseries`.\nThe following product family has been **deprecated**: `audit_logs`."
            },
            {
              "key": "filter[include_descendants]",
              "value": "false",
              "description": "Include child org usage in the response. Defaults to false."
            },
            {
              "key": "filter[include_breakdown]",
              "value": "false",
              "description": "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false."
            },
            {
              "key": "filter[versions]",
              "value": "<string>",
              "description": "Comma separated list of product family versions to use in the format `product_family:version`. For example,\n`infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested\nproduct family. Currently all families have one version `1.0.0`."
            },
            {
              "key": "page[limit]",
              "value": "500",
              "description": "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified."
            },
            {
              "key": "page[next_record_id]",
              "value": "<string>",
              "description": "List following results with a next_record_id provided in the previous query."
            }
          ]
        }
      },
      "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/hourly_usage?filter[timestamp][start]=<dateTime>&filter[timestamp][end]=<dateTime>&filter[product_families]=<string>&filter[include_descendants]=false&filter[include_breakdown]=false&filter[versions]=<string>&page[limit]=500&page[next_record_id]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "hourly_usage"
          ],
          "query": [
            {
              "key": "filter[timestamp][start]",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
            },
            {
              "key": "filter[timestamp][end]",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
            },
            {
              "key": "filter[product_families]",
              "value": "<string>",
              "description": "(Required) Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`,\n`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,\n`cspm`, `custom_events`, `cws`, `dbm`, `fargate`,\n`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`,\n`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `observability_pipelines`,\n`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`, `sds`, `snmp`,\n`synthetics_api`, `synthetics_browser`, `synthetics_parallel_testing`, and `timeseries`.\nThe following product family has been **deprecated**: `audit_logs`."
            },
            {
              "key": "filter[include_descendants]",
              "value": "false",
              "description": "Include child org usage in the response. Defaults to false."
            },
            {
              "key": "filter[include_breakdown]",
              "value": "false",
              "description": "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false."
            },
            {
              "key": "filter[versions]",
              "value": "<string>",
              "description": "Comma separated list of product family versions to use in the format `product_family:version`. For example,\n`infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested\nproduct family. Currently all families have one version `1.0.0`."
            },
            {
              "key": "page[limit]",
              "value": "500",
              "description": "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified."
            },
            {
              "key": "page[next_record_id]",
              "value": "<string>",
              "description": "List following results with a next_record_id provided in the previous query."
            }
          ]
        }
      },
      "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}"
    }
  ]
}