Chilkat Online Tools

PowerBuilder / Datadog API Collection / Get a given APM retention filter

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_V_Type
string ls_Created_at
string ls_Created_by
string ls_Editable
string ls_Enabled
string ls_Execution_order
string ls_Query
string ls_Filter_type
string ls_Modified_at
string ls_Modified_by
string ls_Name
string ls_Rate

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.SetRequestHeader("Accept","application/json")

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters/:filter_id",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

// 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

ls_Id = loo_JResp.StringOf("data.id")
ls_V_Type = loo_JResp.StringOf("data.type")
ls_Created_at = loo_JResp.StringOf("data.attributes.created_at")
ls_Created_by = loo_JResp.StringOf("data.attributes.created_by")
ls_Editable = loo_JResp.StringOf("data.attributes.editable")
ls_Enabled = loo_JResp.StringOf("data.attributes.enabled")
ls_Execution_order = loo_JResp.StringOf("data.attributes.execution_order")
ls_Query = loo_JResp.StringOf("data.attributes.filter.query")
ls_Filter_type = loo_JResp.StringOf("data.attributes.filter_type")
ls_Modified_at = loo_JResp.StringOf("data.attributes.modified_at")
ls_Modified_by = loo_JResp.StringOf("data.attributes.modified_by")
ls_Name = loo_JResp.StringOf("data.attributes.name")
ls_Rate = loo_JResp.StringOf("data.attributes.rate")


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters/:filter_id

Postman Collection Item JSON

{
  "name": "Get a given APM retention filter",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "apm",
        "config",
        "retention-filters",
        ":filter_id"
      ],
      "variable": [
        {
          "key": "filter_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Get an APM retention filter."
  },
  "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/:filter_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "config",
            "retention-filters",
            ":filter_id"
          ],
          "variable": [
            {
              "key": "filter_id"
            }
          ]
        }
      },
      "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": "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/:filter_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "config",
            "retention-filters",
            ":filter_id"
          ],
          "variable": [
            {
              "key": "filter_id"
            }
          ]
        }
      },
      "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": "Not Found",
      "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/:filter_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "config",
            "retention-filters",
            ":filter_id"
          ],
          "variable": [
            {
              "key": "filter_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_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/:filter_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "config",
            "retention-filters",
            ":filter_id"
          ],
          "variable": [
            {
              "key": "filter_id"
            }
          ]
        }
      },
      "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}"
    }
  ]
}