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_hr" "1991-02-02T07:22:34.204Z"
CkJsonObject_UpdateString $queryParams "end_hr" "1991-02-02T07:22:34.204Z"
CkJsonObject_UpdateString $queryParams "index_name" "dolor cillum in"
CkJsonObject_UpdateString $queryParams "index_name" "proident"
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/v1/usage/logs_by_index" $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)
# {
# "usage": [
# {
# "event_count": 1096633,
# "hour": "1994-03-03T08:01:45.382Z",
# "index_id": "id dolor ut aliquip",
# "index_name": "Excepteur qui",
# "org_name": "commodo cillum",
# "public_id": "nisi laboris quis sit",
# "retention": -69735290
# },
# {
# "event_count": -87462345,
# "hour": "2006-02-26T02:53:48.424Z",
# "index_id": "ut cillum esse eu",
# "index_name": "irure et sunt magna",
# "org_name": "quis eiusmod culpa",
# "public_id": "et ea occaecat sit laboris",
# "retention": -29487879
# }
# ]
# }
# 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 "usage"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set event_count [CkJsonObject_IntOf $jResp "usage[i].event_count"]
set hour [CkJsonObject_stringOf $jResp "usage[i].hour"]
set index_id [CkJsonObject_stringOf $jResp "usage[i].index_id"]
set index_name [CkJsonObject_stringOf $jResp "usage[i].index_name"]
set org_name [CkJsonObject_stringOf $jResp "usage[i].org_name"]
set public_id [CkJsonObject_stringOf $jResp "usage[i].public_id"]
set retention [CkJsonObject_IntOf $jResp "usage[i].retention"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "start_hr=1991-02-02T07%3A22%3A34.204Z"
-d "end_hr=1991-02-02T07%3A22%3A34.204Z"
-d "index_name=dolor%20cillum%20in"
-d "index_name=proident"
-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v1/usage/logs_by_index
Postman Collection Item JSON
{
"name": "Get hourly usage for logs by index",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/logs_by_index?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&index_name=dolor cillum in&index_name=proident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"query": [
{
"key": "start_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "index_name",
"value": "dolor cillum in",
"description": "Comma-separated list of log index names."
},
{
"key": "index_name",
"value": "proident",
"description": "Comma-separated list of log index names."
}
]
},
"description": "Get hourly usage for logs by index."
},
"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/logs_by_index?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&index_name=proident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"query": [
{
"key": "start_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "index_name",
"value": "proident",
"description": "Comma-separated list of log index names."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [
],
"body": "{\n \"usage\": [\n {\n \"event_count\": 1096633,\n \"hour\": \"1994-03-03T08:01:45.382Z\",\n \"index_id\": \"id dolor ut aliquip\",\n \"index_name\": \"Excepteur qui\",\n \"org_name\": \"commodo cillum\",\n \"public_id\": \"nisi laboris quis sit\",\n \"retention\": -69735290\n },\n {\n \"event_count\": -87462345,\n \"hour\": \"2006-02-26T02:53:48.424Z\",\n \"index_id\": \"ut cillum esse eu\",\n \"index_name\": \"irure et sunt magna\",\n \"org_name\": \"quis eiusmod culpa\",\n \"public_id\": \"et ea occaecat sit laboris\",\n \"retention\": -29487879\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/logs_by_index?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&index_name=proident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"query": [
{
"key": "start_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "index_name",
"value": "proident",
"description": "Comma-separated list of log index names."
}
]
}
},
"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/logs_by_index?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&index_name=proident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"query": [
{
"key": "start_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "index_name",
"value": "proident",
"description": "Comma-separated list of log index names."
}
]
}
},
"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/logs_by_index?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&index_name=proident",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"logs_by_index"
],
"query": [
{
"key": "start_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour."
},
{
"key": "end_hr",
"value": "1991-02-02T07:22:34.204Z",
"description": "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour."
},
{
"key": "index_name",
"value": "proident",
"description": "Comma-separated list of log index names."
}
]
}
},
"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}"
}
]
}
