Chilkat Online Tools

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

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Id: WideString;
v_Type: WideString;
Created_at: WideString;
Created_by: WideString;
Editable: WideString;
Enabled: WideString;
Execution_order: WideString;
Query: WideString;
Filter_type: WideString;
Modified_at: WideString;
Modified_by: WideString;
Name: WideString;
Rate: WideString;

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

http := TChilkatHttp.Create(Self);

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

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters/:filter_id',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

Id := jResp.StringOf('data.id');
v_Type := jResp.StringOf('data.type');
Created_at := jResp.StringOf('data.attributes.created_at');
Created_by := jResp.StringOf('data.attributes.created_by');
Editable := jResp.StringOf('data.attributes.editable');
Enabled := jResp.StringOf('data.attributes.enabled');
Execution_order := jResp.StringOf('data.attributes.execution_order');
Query := jResp.StringOf('data.attributes.filter.query');
Filter_type := jResp.StringOf('data.attributes.filter_type');
Modified_at := jResp.StringOf('data.attributes.modified_at');
Modified_by := jResp.StringOf('data.attributes.modified_by');
Name := jResp.StringOf('data.attributes.name');
Rate := 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}"
    }
  ]
}