Chilkat Online Tools

DataFlex / Datadog API Collection / Get all custom metrics by hourly average

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vQueryParams
    Handle hoQueryParams
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    Integer iAvg_metric_hour
    Integer iMax_metric_hour
    String sMetric_category
    String sMetric_name
    String sDay
    String sMonth
    Integer iLimit
    String sNext_record_id
    Integer iTotal_number_of_records
    Integer i
    Integer iCount_i
    String sTemp1
    Boolean bTemp1

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
    If (Not(IsComObjectCreated(hoQueryParams))) Begin
        Send CreateComObject of hoQueryParams
    End
    Get ComUpdateString Of hoQueryParams "month" "1991-02-02T07:22:34.204Z" To iSuccess
    Get ComUpdateString Of hoQueryParams "day" "1991-02-02T07:22:34.204Z" To iSuccess
    Get ComUpdateString Of hoQueryParams "names" "dolor cillum in" To iSuccess
    Get ComUpdateString Of hoQueryParams "names" "proident" To iSuccess
    Get ComUpdateInt Of hoQueryParams "limit" 500 To iSuccess
    Get ComUpdateString Of hoQueryParams "next_record_id" "tempor Ut sed velit" To iSuccess

    Send ComSetRequestHeader To hoHttp "Accept" "application/json;datetime-format=rfc3339"

    Get pvComObject of hoQueryParams to vQueryParams
    Get ComQuickRequestParams Of hoHttp "GET" "https://api.app.ddog-gov.com/api/v1/usage/top_avg_metrics" vQueryParams To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

    // 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

    Get ComStringOf Of hoJResp "metadata.day" To sDay
    Get ComStringOf Of hoJResp "metadata.month" To sMonth
    Get ComIntOf Of hoJResp "metadata.pagination.limit" To iLimit
    Get ComStringOf Of hoJResp "metadata.pagination.next_record_id" To sNext_record_id
    Get ComIntOf Of hoJResp "metadata.pagination.total_number_of_records" To iTotal_number_of_records
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "usage" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComIntOf Of hoJResp "usage[i].avg_metric_hour" To iAvg_metric_hour
        Get ComIntOf Of hoJResp "usage[i].max_metric_hour" To iMax_metric_hour
        Get ComStringOf Of hoJResp "usage[i].metric_category" To sMetric_category
        Get ComStringOf Of hoJResp "usage[i].metric_name" To sMetric_name
        Move (i + 1) To i
    Loop



End_Procedure

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}"
    }
  ]
}