PowerBuilder / Datadog API Collection / Get hourly usage for observability pipelines
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_Usage_type
string ls_Id
string ls_V_type
integer j
integer li_Count_j
string ls_Timestamp
string ls_Value
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("start_hr","<dateTime>")
loo_QueryParams.UpdateString("end_hr","<dateTime>")
loo_Http.SetRequestHeader("Accept","application/json;datetime-format=rfc3339")
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/usage/observability_pipelines",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": {
// "org_name": "<string>",
// "product_family": "<string>",
// "public_id": "<string>",
// "region": "<string>",
// "timeseries": [
// {
// "timestamp": "<dateTime>",
// "value": "<long>"
// },
// {
// "timestamp": "<dateTime>",
// "value": "<long>"
// }
// ],
// "usage_type": "observability_pipelines_bytes_processed"
// },
// "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": "app_sec_host_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
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_Usage_type = loo_JResp.StringOf("data[i].attributes.usage_type")
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.timeseries")
do while j < li_Count_j
loo_JResp.J = j
ls_Timestamp = loo_JResp.StringOf("data[i].attributes.timeseries[j].timestamp")
ls_Value = loo_JResp.StringOf("data[i].attributes.timeseries[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 "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/observability_pipelines
Postman Collection Item JSON
{
"name": "Get hourly usage for observability pipelines",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/observability_pipelines?start_hr=<dateTime>&end_hr=<dateTime>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"observability_pipelines"
],
"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 observability pipelines.\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/observability_pipelines?start_hr=<dateTime>&end_hr=<dateTime>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"observability_pipelines"
],
"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\": \"observability_pipelines_bytes_processed\"\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\": \"app_sec_host_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/observability_pipelines?start_hr=<dateTime>&end_hr=<dateTime>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"observability_pipelines"
],
"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/observability_pipelines?start_hr=<dateTime>&end_hr=<dateTime>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"observability_pipelines"
],
"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/observability_pipelines?start_hr=<dateTime>&end_hr=<dateTime>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"observability_pipelines"
],
"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}"
}
]
}
