lianja / Datadog API Collection / Get historical cost across your account
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("view","<string>")
loQueryParams.UpdateString("start_month","<dateTime>")
loQueryParams.UpdateString("end_month","<dateTime>")
loHttp.SetRequestHeader("Accept","application/json;datetime-format=rfc3339")
loResp = loHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/usage/historical_cost",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
i = 0
lnCount_i = loJResp.SizeOfArray("data")
do while i < lnCount_i
loJResp.I = i
lcDate = loJResp.StringOf("data[i].attributes.date")
lcOrg_name = loJResp.StringOf("data[i].attributes.org_name")
lcPublic_id = loJResp.StringOf("data[i].attributes.public_id")
lcRegion = loJResp.StringOf("data[i].attributes.region")
lcTotal_cost = loJResp.StringOf("data[i].attributes.total_cost")
lcId = loJResp.StringOf("data[i].id")
lcV_type = loJResp.StringOf("data[i].type")
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].attributes.charges")
do while j < lnCount_j
loJResp.J = j
lcCharge_type = loJResp.StringOf("data[i].attributes.charges[j].charge_type")
lcCost = loJResp.StringOf("data[i].attributes.charges[j].cost")
lcProduct_name = loJResp.StringOf("data[i].attributes.charges[j].product_name")
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
Curl Command
curl -G -d "view=%3Cstring%3E"
-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/historical_cost
Postman Collection Item JSON
{
"name": "Get historical cost across your account",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/usage/historical_cost?view=<string>&start_month=<dateTime>&end_month=<dateTime>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"historical_cost"
],
"query": [
{
"key": "view",
"value": "<string>",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"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 historical cost across multi-org and single root-org accounts.\nCost data for a given month becomes available no later than the 16th of the following month."
},
"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/historical_cost?view=<string>&start_month=<dateTime>&end_month=<dateTime>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"historical_cost"
],
"query": [
{
"key": "view",
"value": "<string>",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"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/historical_cost?view=<string>&start_month=<dateTime>&end_month=<dateTime>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"historical_cost"
],
"query": [
{
"key": "view",
"value": "<string>",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"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/historical_cost?view=<string>&start_month=<dateTime>&end_month=<dateTime>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"historical_cost"
],
"query": [
{
"key": "view",
"value": "<string>",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"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/historical_cost?view=<string>&start_month=<dateTime>&end_month=<dateTime>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"usage",
"historical_cost"
],
"query": [
{
"key": "view",
"value": "<string>",
"description": "String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`."
},
{
"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}"
}
]
}
