Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sV_Type
String sCreated_at
String sCreated_by
String sEditable
String sEnabled
String sExecution_order
String sQuery
String sFilter_type
String sModified_at
String sModified_by
String sName
String sRate
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "data": {
// "attributes": {
// "name": "<string>",
// "filter": {
// "query": "<string>"
// },
// "enabled": "<boolean>",
// "filter_type": "spans-sampling-processor",
// "rate": "<double>"
// },
// "type": "apm_retention_filter"
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "data.attributes.name" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.attributes.filter.query" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.attributes.enabled" "<boolean>" To iSuccess
Get ComUpdateString Of hoJson "data.attributes.filter_type" "spans-sampling-processor" To iSuccess
Get ComUpdateString Of hoJson "data.attributes.rate" "<double>" To iSuccess
Get ComUpdateString Of hoJson "data.type" "apm_retention_filter" To iSuccess
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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>"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "data.id" To sId
Get ComStringOf Of hoJResp "data.type" To sV_Type
Get ComStringOf Of hoJResp "data.attributes.created_at" To sCreated_at
Get ComStringOf Of hoJResp "data.attributes.created_by" To sCreated_by
Get ComStringOf Of hoJResp "data.attributes.editable" To sEditable
Get ComStringOf Of hoJResp "data.attributes.enabled" To sEnabled
Get ComStringOf Of hoJResp "data.attributes.execution_order" To sExecution_order
Get ComStringOf Of hoJResp "data.attributes.filter.query" To sQuery
Get ComStringOf Of hoJResp "data.attributes.filter_type" To sFilter_type
Get ComStringOf Of hoJResp "data.attributes.modified_at" To sModified_at
Get ComStringOf Of hoJResp "data.attributes.modified_by" To sModified_by
Get ComStringOf Of hoJResp "data.attributes.name" To sName
Get ComStringOf Of hoJResp "data.attributes.rate" To sRate
End_Procedure
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"name": "<string>",
"filter": {
"query": "<string>"
},
"enabled": "<boolean>",
"filter_type": "spans-sampling-processor",
"rate": "<double>"
},
"type": "apm_retention_filter"
}
}'
https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters
Postman Collection Item JSON
{
"name": "Create a retention filter",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
},
"description": "Create a retention filter to index spans in your organization.\nReturns the retention filter definition when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"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 \"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}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"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": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "Conflict",
"code": 409,
"_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": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"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}"
}
]
}
