Chilkat Online Tools

C++ / Datadog API Collection / List all APM retention filters

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

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

    CkHttp http;
    bool success;

    http.SetRequestHeader("Accept","application/json");

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        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>"
    //       }
    //     },
    //     {
    //       "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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *id = 0;
    const char *v_type = 0;
    const char *Created_at = 0;
    const char *Created_by = 0;
    const char *Editable = 0;
    const char *Enabled = 0;
    const char *Execution_order = 0;
    const char *Query = 0;
    const char *Filter_type = 0;
    const char *Modified_at = 0;
    const char *Modified_by = 0;
    const char *Name = 0;
    const char *Rate = 0;

    int i = 0;
    int count_i = jResp.SizeOfArray("data");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("data[i].id");
        v_type = jResp.stringOf("data[i].type");
        Created_at = jResp.stringOf("data[i].attributes.created_at");
        Created_by = jResp.stringOf("data[i].attributes.created_by");
        Editable = jResp.stringOf("data[i].attributes.editable");
        Enabled = jResp.stringOf("data[i].attributes.enabled");
        Execution_order = jResp.stringOf("data[i].attributes.execution_order");
        Query = jResp.stringOf("data[i].attributes.filter.query");
        Filter_type = jResp.stringOf("data[i].attributes.filter_type");
        Modified_at = jResp.stringOf("data[i].attributes.modified_at");
        Modified_by = jResp.stringOf("data[i].attributes.modified_by");
        Name = jResp.stringOf("data[i].attributes.name");
        Rate = jResp.stringOf("data[i].attributes.rate");
        i = i + 1;
    }
    }

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