Chilkat Online Tools

Node.js / Datadog API Collection / Get all custom metrics by hourly average

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("month","1991-02-02T07:22:34.204Z");
    queryParams.UpdateString("day","1991-02-02T07:22:34.204Z");
    queryParams.UpdateString("names","dolor cillum in");
    queryParams.UpdateString("names","proident");
    queryParams.UpdateInt("limit",500);
    queryParams.UpdateString("next_record_id","tempor Ut sed velit");

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

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/usage/top_avg_metrics",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)

    // {
    //   "metadata": {
    //     "day": "1970-12-19T21:24:25.324Z",
    //     "month": "1968-08-09T04:45:37.966Z",
    //     "pagination": {
    //       "limit": 93806394,
    //       "next_record_id": "Lorem Excepteur culpa irure",
    //       "total_number_of_records": 92367782
    //     }
    //   },
    //   "usage": [
    //     {
    //       "avg_metric_hour": 6012044,
    //       "max_metric_hour": 51959196,
    //       "metric_category": "standard",
    //       "metric_name": "nisi in"
    //     },
    //     {
    //       "avg_metric_hour": -65971160,
    //       "max_metric_hour": 62447032,
    //       "metric_category": "custom",
    //       "metric_name": "magna sed proident labore"
    //     }
    //   ]
    // }

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

    var avg_metric_hour;
    var max_metric_hour;
    var metric_category;
    var metric_name;

    var Day = jResp.StringOf("metadata.day");
    var Month = jResp.StringOf("metadata.month");
    var Limit = jResp.IntOf("metadata.pagination.limit");
    var Next_record_id = jResp.StringOf("metadata.pagination.next_record_id");
    var Total_number_of_records = jResp.IntOf("metadata.pagination.total_number_of_records");
    var i = 0;
    var count_i = jResp.SizeOfArray("usage");
    while (i < count_i) {
        jResp.I = i;
        avg_metric_hour = jResp.IntOf("usage[i].avg_metric_hour");
        max_metric_hour = jResp.IntOf("usage[i].max_metric_hour");
        metric_category = jResp.StringOf("usage[i].metric_category");
        metric_name = jResp.StringOf("usage[i].metric_name");
        i = i+1;
    }


}

chilkatExample();

Curl Command

curl -G -d "month=1991-02-02T07%3A22%3A34.204Z"
	-d "day=1991-02-02T07%3A22%3A34.204Z"
	-d "names=dolor%20cillum%20in"
	-d "names=proident"
	-d "limit=500"
	-d "next_record_id=tempor%20Ut%20sed%20velit"
	-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v1/usage/top_avg_metrics

Postman Collection Item JSON

{
  "name": "Get all custom metrics by hourly average",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json;datetime-format=rfc3339"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/usage/top_avg_metrics?month=1991-02-02T07:22:34.204Z&day=1991-02-02T07:22:34.204Z&names=dolor cillum in&names=proident&limit=500&next_record_id=tempor Ut sed velit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "usage",
        "top_avg_metrics"
      ],
      "query": [
        {
          "key": "month",
          "value": "1991-02-02T07:22:34.204Z",
          "description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
        },
        {
          "key": "day",
          "value": "1991-02-02T07:22:34.204Z",
          "description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
        },
        {
          "key": "names",
          "value": "dolor cillum in",
          "description": "Comma-separated list of metric names."
        },
        {
          "key": "names",
          "value": "proident",
          "description": "Comma-separated list of metric names."
        },
        {
          "key": "limit",
          "value": "500",
          "description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
        },
        {
          "key": "next_record_id",
          "value": "tempor Ut sed velit",
          "description": "List following results with a next_record_id provided in the previous query."
        }
      ]
    },
    "description": "Get all [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) by hourly average. Use the month parameter to get a month-to-date data resolution or use the day parameter to get a daily resolution. One of the two is required, and only one of the two is allowed."
  },
  "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/top_avg_metrics?month=1991-02-02T07:22:34.204Z&day=1991-02-02T07:22:34.204Z&names=proident&limit=500&next_record_id=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "top_avg_metrics"
          ],
          "query": [
            {
              "key": "month",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
            },
            {
              "key": "day",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
            },
            {
              "key": "names",
              "value": "proident",
              "description": "Comma-separated list of metric names."
            },
            {
              "key": "limit",
              "value": "500",
              "description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
            },
            {
              "key": "next_record_id",
              "value": "tempor Ut sed velit",
              "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  \"metadata\": {\n    \"day\": \"1970-12-19T21:24:25.324Z\",\n    \"month\": \"1968-08-09T04:45:37.966Z\",\n    \"pagination\": {\n      \"limit\": 93806394,\n      \"next_record_id\": \"Lorem Excepteur culpa irure\",\n      \"total_number_of_records\": 92367782\n    }\n  },\n  \"usage\": [\n    {\n      \"avg_metric_hour\": 6012044,\n      \"max_metric_hour\": 51959196,\n      \"metric_category\": \"standard\",\n      \"metric_name\": \"nisi in\"\n    },\n    {\n      \"avg_metric_hour\": -65971160,\n      \"max_metric_hour\": 62447032,\n      \"metric_category\": \"custom\",\n      \"metric_name\": \"magna sed proident labore\"\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/top_avg_metrics?month=1991-02-02T07:22:34.204Z&day=1991-02-02T07:22:34.204Z&names=proident&limit=500&next_record_id=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "top_avg_metrics"
          ],
          "query": [
            {
              "key": "month",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
            },
            {
              "key": "day",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
            },
            {
              "key": "names",
              "value": "proident",
              "description": "Comma-separated list of metric names."
            },
            {
              "key": "limit",
              "value": "500",
              "description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
            },
            {
              "key": "next_record_id",
              "value": "tempor Ut sed velit",
              "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    \"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/top_avg_metrics?month=1991-02-02T07:22:34.204Z&day=1991-02-02T07:22:34.204Z&names=proident&limit=500&next_record_id=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "top_avg_metrics"
          ],
          "query": [
            {
              "key": "month",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
            },
            {
              "key": "day",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
            },
            {
              "key": "names",
              "value": "proident",
              "description": "Comma-separated list of metric names."
            },
            {
              "key": "limit",
              "value": "500",
              "description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
            },
            {
              "key": "next_record_id",
              "value": "tempor Ut sed velit",
              "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    \"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/top_avg_metrics?month=1991-02-02T07:22:34.204Z&day=1991-02-02T07:22:34.204Z&names=proident&limit=500&next_record_id=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "top_avg_metrics"
          ],
          "query": [
            {
              "key": "month",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)"
            },
            {
              "key": "day",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)"
            },
            {
              "key": "names",
              "value": "proident",
              "description": "Comma-separated list of metric names."
            },
            {
              "key": "limit",
              "value": "500",
              "description": "Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified."
            },
            {
              "key": "next_record_id",
              "value": "tempor Ut sed velit",
              "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    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}