Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("start_hr","1991-02-02T07:22:34.204Z")
success = queryParams.UpdateString("end_hr","1991-02-02T07:22:34.204Z")
http.SetRequestHeader "Accept","application/json;datetime-format=rfc3339"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/usage/ci-app",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "usage": [
' {
' "ci_pipeline_indexed_spans": -5402073,
' "ci_test_indexed_spans": -88744639,
' "ci_visibility_itr_committers": -51139220,
' "ci_visibility_pipeline_committers": 13817178,
' "ci_visibility_test_committers": 99022641,
' "org_name": "sed sint sit",
' "public_id": "ipsum minim in"
' },
' {
' "ci_pipeline_indexed_spans": -14898313,
' "ci_test_indexed_spans": 85106726,
' "ci_visibility_itr_committers": -80058598,
' "ci_visibility_pipeline_committers": -30449048,
' "ci_visibility_test_committers": 95504246,
' "org_name": "ea occaecat",
' "public_id": "ad tempor amet eu aliquip"
' }
' ]
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim ci_pipeline_indexed_spans As Long
Dim ci_test_indexed_spans As Long
Dim ci_visibility_itr_committers As Long
Dim ci_visibility_pipeline_committers As Long
Dim ci_visibility_test_committers As Long
Dim org_name As String
Dim public_id As String
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("usage")
Do While i < count_i
jResp.I = i
ci_pipeline_indexed_spans = jResp.IntOf("usage[i].ci_pipeline_indexed_spans")
ci_test_indexed_spans = jResp.IntOf("usage[i].ci_test_indexed_spans")
ci_visibility_itr_committers = jResp.IntOf("usage[i].ci_visibility_itr_committers")
ci_visibility_pipeline_committers = jResp.IntOf("usage[i].ci_visibility_pipeline_committers")
ci_visibility_test_committers = jResp.IntOf("usage[i].ci_visibility_test_committers")
org_name = jResp.StringOf("usage[i].org_name")
public_id = jResp.StringOf("usage[i].public_id")
i = i + 1
Loop
Curl Command
curl -G -d "start_hr=1991-02-02T07%3A22%3A34.204Z"
-d "end_hr=1991-02-02T07%3A22%3A34.204Z"
-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v1/usage/ci-app
Postman Collection Item JSON
{
"name": "Get hourly usage for CI visibility",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json;datetime-format=rfc3339"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/usage/ci-app?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"ci-app"
],
"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\n**before** this hour."
}
]
},
"description": "Get hourly usage for CI visibility (tests, pipeline, and spans).\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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide."
},
"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/ci-app?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"ci-app"
],
"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\n**before** this hour."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;datetime-format=rfc3339"
}
],
"cookie": [
],
"body": "{\n \"usage\": [\n {\n \"ci_pipeline_indexed_spans\": -5402073,\n \"ci_test_indexed_spans\": -88744639,\n \"ci_visibility_itr_committers\": -51139220,\n \"ci_visibility_pipeline_committers\": 13817178,\n \"ci_visibility_test_committers\": 99022641,\n \"org_name\": \"sed sint sit\",\n \"public_id\": \"ipsum minim in\"\n },\n {\n \"ci_pipeline_indexed_spans\": -14898313,\n \"ci_test_indexed_spans\": 85106726,\n \"ci_visibility_itr_committers\": -80058598,\n \"ci_visibility_pipeline_committers\": -30449048,\n \"ci_visibility_test_committers\": 95504246,\n \"org_name\": \"ea occaecat\",\n \"public_id\": \"ad tempor amet eu aliquip\"\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/ci-app?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"ci-app"
],
"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\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 \"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/ci-app?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"ci-app"
],
"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\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 \"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/ci-app?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"usage",
"ci-app"
],
"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\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 \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
