PureBasic / Datadog API Collection / List all APM retention filters
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": [
; {
; "id": "<string>",
; "type": "apm_retention_filter",
; "attributes": {
; "created_at": "<long>",
; "created_by": "<string>",
; "editable": "<boolean>",
; "enabled": "<boolean>",
; "execution_order": "<long>",
; "filter": {
; "query": "<string>"
; },
; "filter_type": "spans-sampling-processor",
; "modified_at": "<long>",
; "modified_by": "<string>",
; "name": "<string>",
; "rate": "<double>"
; }
; },
; {
; "id": "<string>",
; "type": "apm_retention_filter",
; "attributes": {
; "created_at": "<long>",
; "created_by": "<string>",
; "editable": "<boolean>",
; "enabled": "<boolean>",
; "execution_order": "<long>",
; "filter": {
; "query": "<string>"
; },
; "filter_type": "spans-sampling-processor",
; "modified_at": "<long>",
; "modified_by": "<string>",
; "name": "<string>",
; "rate": "<double>"
; }
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s
v_type.s
Created_at.s
Created_by.s
Editable.s
Enabled.s
Execution_order.s
Query.s
Filter_type.s
Modified_at.s
Modified_by.s
Name.s
Rate.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data[i].id")
v_type = CkJsonObject::ckStringOf(jResp,"data[i].type")
Created_at = CkJsonObject::ckStringOf(jResp,"data[i].attributes.created_at")
Created_by = CkJsonObject::ckStringOf(jResp,"data[i].attributes.created_by")
Editable = CkJsonObject::ckStringOf(jResp,"data[i].attributes.editable")
Enabled = CkJsonObject::ckStringOf(jResp,"data[i].attributes.enabled")
Execution_order = CkJsonObject::ckStringOf(jResp,"data[i].attributes.execution_order")
Query = CkJsonObject::ckStringOf(jResp,"data[i].attributes.filter.query")
Filter_type = CkJsonObject::ckStringOf(jResp,"data[i].attributes.filter_type")
Modified_at = CkJsonObject::ckStringOf(jResp,"data[i].attributes.modified_at")
Modified_by = CkJsonObject::ckStringOf(jResp,"data[i].attributes.modified_by")
Name = CkJsonObject::ckStringOf(jResp,"data[i].attributes.name")
Rate = CkJsonObject::ckStringOf(jResp,"data[i].attributes.rate")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters
Postman Collection Item JSON
{
"name": "List all APM retention filters",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
},
"description": "Get the list of APM retention filters."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"apm_retention_filter\",\n \"attributes\": {\n \"created_at\": \"<long>\",\n \"created_by\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"enabled\": \"<boolean>\",\n \"execution_order\": \"<long>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"filter_type\": \"spans-sampling-processor\",\n \"modified_at\": \"<long>\",\n \"modified_by\": \"<string>\",\n \"name\": \"<string>\",\n \"rate\": \"<double>\"\n }\n },\n {\n \"id\": \"<string>\",\n \"type\": \"apm_retention_filter\",\n \"attributes\": {\n \"created_at\": \"<long>\",\n \"created_by\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"enabled\": \"<boolean>\",\n \"execution_order\": \"<long>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"filter_type\": \"spans-sampling-processor\",\n \"modified_at\": \"<long>\",\n \"modified_by\": \"<string>\",\n \"name\": \"<string>\",\n \"rate\": \"<double>\"\n }\n }\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}