delphiDll / Datadog API Collection / Get hourly usage for observability pipelines
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Org_name: PWideChar;
Product_family: PWideChar;
Public_id: PWideChar;
Region: PWideChar;
Usage_type: PWideChar;
id: PWideChar;
v_type: PWideChar;
j: Integer;
count_j: Integer;
timestamp: PWideChar;
value: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'start_hr','<dateTime>');
CkJsonObject_UpdateString(queryParams,'end_hr','<dateTime>');
CkHttp_SetRequestHeader(http,'Accept','application/json;datetime-format=rfc3339');
resp := CkHttp_QuickRequestParams(http,'GET','https://api.app.ddog-gov.com/api/v2/usage/observability_pipelines',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(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;
count_i := CkJsonObject_SizeOfArray(jResp,'data');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
Org_name := CkJsonObject__stringOf(jResp,'data[i].attributes.org_name');
Product_family := CkJsonObject__stringOf(jResp,'data[i].attributes.product_family');
Public_id := CkJsonObject__stringOf(jResp,'data[i].attributes.public_id');
Region := CkJsonObject__stringOf(jResp,'data[i].attributes.region');
Usage_type := CkJsonObject__stringOf(jResp,'data[i].attributes.usage_type');
id := CkJsonObject__stringOf(jResp,'data[i].id');
v_type := CkJsonObject__stringOf(jResp,'data[i].type');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'data[i].attributes.timeseries');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
timestamp := CkJsonObject__stringOf(jResp,'data[i].attributes.timeseries[j].timestamp');
value := CkJsonObject__stringOf(jResp,'data[i].attributes.timeseries[j].value');
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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}"
}
]
}
