PowerBuilder / Datadog API Collection / Get hourly usage by product family
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Org_name
string ls_Product_family
string ls_Public_id
string ls_Region
string ls_Timestamp
string ls_Id
string ls_V_type
integer j
integer li_Count_j
string ls_Usage_type
string ls_Value
string ls_Next_record_id
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("filter[timestamp][start]","<dateTime>")
loo_QueryParams.UpdateString("filter[timestamp][end]","<dateTime>")
loo_QueryParams.UpdateString("filter[product_families]","<string>")
loo_QueryParams.UpdateString("filter[include_descendants]","false")
loo_QueryParams.UpdateString("filter[include_breakdown]","false")
loo_QueryParams.UpdateString("filter[versions]","<string>")
loo_QueryParams.UpdateInt("page[limit]",500)
loo_QueryParams.UpdateString("page[next_record_id]","<string>")
loo_Http.SetRequestHeader("Accept","application/json;datetime-format=rfc3339")
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/usage/hourly_usage",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
ls_Next_record_id = loo_JResp.StringOf("meta.pagination.next_record_id")
i = 0
li_Count_i = loo_JResp.SizeOfArray("data")
do while i < li_Count_i
loo_JResp.I = i
ls_Org_name = loo_JResp.StringOf("data[i].attributes.org_name")
ls_Product_family = loo_JResp.StringOf("data[i].attributes.product_family")
ls_Public_id = loo_JResp.StringOf("data[i].attributes.public_id")
ls_Region = loo_JResp.StringOf("data[i].attributes.region")
ls_Timestamp = loo_JResp.StringOf("data[i].attributes.timestamp")
ls_Id = loo_JResp.StringOf("data[i].id")
ls_V_type = loo_JResp.StringOf("data[i].type")
j = 0
li_Count_j = loo_JResp.SizeOfArray("data[i].attributes.measurements")
do while j < li_Count_j
loo_JResp.J = j
ls_Usage_type = loo_JResp.StringOf("data[i].attributes.measurements[j].usage_type")
ls_Value = loo_JResp.StringOf("data[i].attributes.measurements[j].value")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
