Chilkat Online Tools

PureBasic / Datadog API Collection / Get hourly usage for Lambda traced invocations

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    queryParams.i = CkJsonObject::ckCreate()
    If queryParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(queryParams,"start_hr","<dateTime>")
    CkJsonObject::ckUpdateString(queryParams,"end_hr","<dateTime>")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json;datetime-format=rfc3339")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.app.ddog-gov.com/api/v2/usage/lambda_traced_invocations",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(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": "lambda_traced_invocations_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

    Org_name.s
    Product_family.s
    Public_id.s
    Region.s
    Usage_type.s
    id.s
    v_type.s
    j.i
    count_j.i
    timestamp.s
    value.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Org_name = CkJsonObject::ckStringOf(jResp,"data[i].attributes.org_name")
        Product_family = CkJsonObject::ckStringOf(jResp,"data[i].attributes.product_family")
        Public_id = CkJsonObject::ckStringOf(jResp,"data[i].attributes.public_id")
        Region = CkJsonObject::ckStringOf(jResp,"data[i].attributes.region")
        Usage_type = CkJsonObject::ckStringOf(jResp,"data[i].attributes.usage_type")
        id = CkJsonObject::ckStringOf(jResp,"data[i].id")
        v_type = CkJsonObject::ckStringOf(jResp,"data[i].type")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].attributes.timeseries")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            timestamp = CkJsonObject::ckStringOf(jResp,"data[i].attributes.timeseries[j].timestamp")
            value = CkJsonObject::ckStringOf(jResp,"data[i].attributes.timeseries[j].value")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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

Postman Collection Item JSON

{
  "name": "Get hourly usage for Lambda traced invocations",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json;datetime-format=rfc3339"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/usage/lambda_traced_invocations?start_hr=<dateTime>&end_hr=<dateTime>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "usage",
        "lambda_traced_invocations"
      ],
      "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 lambda traced invocations.\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/lambda_traced_invocations?start_hr=<dateTime>&end_hr=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "lambda_traced_invocations"
          ],
          "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\": \"lambda_traced_invocations_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/lambda_traced_invocations?start_hr=<dateTime>&end_hr=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "lambda_traced_invocations"
          ],
          "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/lambda_traced_invocations?start_hr=<dateTime>&end_hr=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "lambda_traced_invocations"
          ],
          "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/lambda_traced_invocations?start_hr=<dateTime>&end_hr=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "lambda_traced_invocations"
          ],
          "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}"
    }
  ]
}