Chilkat Online Tools

TCL / Datadog API Collection / Get cost across multi-org account

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "start_month" "<dateTime>"
CkJsonObject_UpdateString $queryParams "end_month" "<dateTime>"

CkHttp_SetRequestHeader $http "Accept" "application/json;datetime-format=rfc3339"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.app.ddog-gov.com/api/v2/usage/cost_by_org" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "data": [
#     {
#       "attributes": {
#         "charges": [
#           {
#             "charge_type": "<string>",
#             "cost": "<double>",
#             "product_name": "<string>"
#           },
#           {
#             "charge_type": "<string>",
#             "cost": "<double>",
#             "product_name": "<string>"
#           }
#         ],
#         "date": "<dateTime>",
#         "org_name": "<string>",
#         "public_id": "<string>",
#         "region": "<string>",
#         "total_cost": "<double>"
#       },
#       "id": "<string>",
#       "type": "cost_by_org"
#     },
#     {
#       "attributes": {
#         "charges": [
#           {
#             "charge_type": "<string>",
#             "cost": "<double>",
#             "product_name": "<string>"
#           },
#           {
#             "charge_type": "<string>",
#             "cost": "<double>",
#             "product_name": "<string>"
#           }
#         ],
#         "date": "<dateTime>",
#         "org_name": "<string>",
#         "public_id": "<string>",
#         "region": "<string>",
#         "total_cost": "<double>"
#       },
#       "id": "<string>",
#       "type": "cost_by_org"
#     }
#   ]
# }

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

set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set Date [CkJsonObject_stringOf $jResp "data[i].attributes.date"]
    set Org_name [CkJsonObject_stringOf $jResp "data[i].attributes.org_name"]
    set Public_id [CkJsonObject_stringOf $jResp "data[i].attributes.public_id"]
    set Region [CkJsonObject_stringOf $jResp "data[i].attributes.region"]
    set Total_cost [CkJsonObject_stringOf $jResp "data[i].attributes.total_cost"]
    set id [CkJsonObject_stringOf $jResp "data[i].id"]
    set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "data[i].attributes.charges"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set charge_type [CkJsonObject_stringOf $jResp "data[i].attributes.charges[j].charge_type"]
        set cost [CkJsonObject_stringOf $jResp "data[i].attributes.charges[j].cost"]
        set product_name [CkJsonObject_stringOf $jResp "data[i].attributes.charges[j].product_name"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -G -d "start_month=%3CdateTime%3E"
	-d "end_month=%3CdateTime%3E"
	-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v2/usage/cost_by_org

Postman Collection Item JSON

{
  "name": "Get cost across multi-org account",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json;datetime-format=rfc3339"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/usage/cost_by_org?start_month=<dateTime>&end_month=<dateTime>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "usage",
        "cost_by_org"
      ],
      "query": [
        {
          "key": "start_month",
          "value": "<dateTime>",
          "description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month."
        },
        {
          "key": "end_month",
          "value": "<dateTime>",
          "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
        }
      ]
    },
    "description": "Get cost across multi-org account.\nCost by org data for a given month becomes available no later than the 16th of the following month.\n**Note:** This endpoint has been deprecated. Please use the new endpoint\n[`/historical_cost`](https://docs.datadoghq.com/api/latest/usage-metering/#get-historical-cost-across-your-account)\ninstead."
  },
  "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/cost_by_org?start_month=<dateTime>&end_month=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "cost_by_org"
          ],
          "query": [
            {
              "key": "start_month",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month."
            },
            {
              "key": "end_month",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
            }
          ]
        }
      },
      "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        \"charges\": [\n          {\n            \"charge_type\": \"<string>\",\n            \"cost\": \"<double>\",\n            \"product_name\": \"<string>\"\n          },\n          {\n            \"charge_type\": \"<string>\",\n            \"cost\": \"<double>\",\n            \"product_name\": \"<string>\"\n          }\n        ],\n        \"date\": \"<dateTime>\",\n        \"org_name\": \"<string>\",\n        \"public_id\": \"<string>\",\n        \"region\": \"<string>\",\n        \"total_cost\": \"<double>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"cost_by_org\"\n    },\n    {\n      \"attributes\": {\n        \"charges\": [\n          {\n            \"charge_type\": \"<string>\",\n            \"cost\": \"<double>\",\n            \"product_name\": \"<string>\"\n          },\n          {\n            \"charge_type\": \"<string>\",\n            \"cost\": \"<double>\",\n            \"product_name\": \"<string>\"\n          }\n        ],\n        \"date\": \"<dateTime>\",\n        \"org_name\": \"<string>\",\n        \"public_id\": \"<string>\",\n        \"region\": \"<string>\",\n        \"total_cost\": \"<double>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"cost_by_org\"\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/cost_by_org?start_month=<dateTime>&end_month=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "cost_by_org"
          ],
          "query": [
            {
              "key": "start_month",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month."
            },
            {
              "key": "end_month",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
            }
          ]
        }
      },
      "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/cost_by_org?start_month=<dateTime>&end_month=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "cost_by_org"
          ],
          "query": [
            {
              "key": "start_month",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month."
            },
            {
              "key": "end_month",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
            }
          ]
        }
      },
      "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/cost_by_org?start_month=<dateTime>&end_month=<dateTime>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "usage",
            "cost_by_org"
          ],
          "query": [
            {
              "key": "start_month",
              "value": "<dateTime>",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month."
            },
            {
              "key": "end_month",
              "value": "<dateTime>",
              "description": "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month."
            }
          ]
        }
      },
      "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}"
    }
  ]
}