Chilkat Online Tools

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

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    http.SetRequestHeader("Accept", value: "application/json")

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters/:filter_id", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

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

    var Id: String? = jResp.StringOf("data.id")
    var v_Type: String? = jResp.StringOf("data.type")
    var Created_at: String? = jResp.StringOf("data.attributes.created_at")
    var Created_by: String? = jResp.StringOf("data.attributes.created_by")
    var Editable: String? = jResp.StringOf("data.attributes.editable")
    var Enabled: String? = jResp.StringOf("data.attributes.enabled")
    var Execution_order: String? = jResp.StringOf("data.attributes.execution_order")
    var Query: String? = jResp.StringOf("data.attributes.filter.query")
    var Filter_type: String? = jResp.StringOf("data.attributes.filter_type")
    var Modified_at: String? = jResp.StringOf("data.attributes.modified_at")
    var Modified_by: String? = jResp.StringOf("data.attributes.modified_by")
    var Name: String? = jResp.StringOf("data.attributes.name")
    var Rate: String? = jResp.StringOf("data.attributes.rate")

}

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}"
    }
  ]
}