Node.js / Datadog API Collection / Get hourly usage for logs by index
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
var queryParams = new chilkat.JsonObject();
queryParams.UpdateString("start_hr","1991-02-02T07:22:34.204Z");
queryParams.UpdateString("end_hr","1991-02-02T07:22:34.204Z");
queryParams.UpdateString("index_name","dolor cillum in");
queryParams.UpdateString("index_name","proident");
http.SetRequestHeader("Accept","application/json;datetime-format=rfc3339");
// resp: HttpResponse
var resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/usage/logs_by_index",queryParams);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "usage": [
// {
// "event_count": 1096633,
// "hour": "1994-03-03T08:01:45.382Z",
// "index_id": "id dolor ut aliquip",
// "index_name": "Excepteur qui",
// "org_name": "commodo cillum",
// "public_id": "nisi laboris quis sit",
// "retention": -69735290
// },
// {
// "event_count": -87462345,
// "hour": "2006-02-26T02:53:48.424Z",
// "index_id": "ut cillum esse eu",
// "index_name": "irure et sunt magna",
// "org_name": "quis eiusmod culpa",
// "public_id": "et ea occaecat sit laboris",
// "retention": -29487879
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var event_count;
var hour;
var index_id;
var index_name;
var org_name;
var public_id;
var retention;
var i = 0;
var count_i = jResp.SizeOfArray("usage");
while (i < count_i) {
jResp.I = i;
event_count = jResp.IntOf("usage[i].event_count");
hour = jResp.StringOf("usage[i].hour");
index_id = jResp.StringOf("usage[i].index_id");
index_name = jResp.StringOf("usage[i].index_name");
org_name = jResp.StringOf("usage[i].org_name");
public_id = jResp.StringOf("usage[i].public_id");
retention = jResp.IntOf("usage[i].retention");
i = i+1;
}
}
chilkatExample();
Curl Command
curl -G -d "start_hr=1991-02-02T07%3A22%3A34.204Z"
-d "end_hr=1991-02-02T07%3A22%3A34.204Z"
-d "index_name=dolor%20cillum%20in"
-d "index_name=proident"
-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v1/usage/logs_by_index
Postman Collection Item JSON
{
"name": "Get hourly usage for logs by index",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/logs_by_index?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&index_name=dolor cillum in&index_name=proident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"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 **before** this hour."
},
{
"key": "index_name",
"value": "dolor cillum in",
"description": "Comma-separated list of log index names."
},
{
"key": "index_name",
"value": "proident",
"description": "Comma-separated list of log index names."
}
]
},
"description": "Get hourly usage for logs by index."
},
"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/logs_by_index?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&index_name=proident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"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 **before** this hour."
},
{
"key": "index_name",
"value": "proident",
"description": "Comma-separated list of log index names."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [
],
"body": "{\n \"usage\": [\n {\n \"event_count\": 1096633,\n \"hour\": \"1994-03-03T08:01:45.382Z\",\n \"index_id\": \"id dolor ut aliquip\",\n \"index_name\": \"Excepteur qui\",\n \"org_name\": \"commodo cillum\",\n \"public_id\": \"nisi laboris quis sit\",\n \"retention\": -69735290\n },\n {\n \"event_count\": -87462345,\n \"hour\": \"2006-02-26T02:53:48.424Z\",\n \"index_id\": \"ut cillum esse eu\",\n \"index_name\": \"irure et sunt magna\",\n \"org_name\": \"quis eiusmod culpa\",\n \"public_id\": \"et ea occaecat sit laboris\",\n \"retention\": -29487879\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/logs_by_index?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&index_name=proident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"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 **before** this hour."
},
{
"key": "index_name",
"value": "proident",
"description": "Comma-separated list of log index names."
}
]
}
},
"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/logs_by_index?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&index_name=proident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"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 **before** this hour."
},
{
"key": "index_name",
"value": "proident",
"description": "Comma-separated list of log index names."
}
]
}
},
"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/logs_by_index?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&index_name=proident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"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 **before** this hour."
},
{
"key": "index_name",
"value": "proident",
"description": "Comma-separated list of log index names."
}
]
}
},
"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}"
}
]
}
