Chilkat Online Tools

C# / Datadog API Collection / List active tags and aggregations

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateString("window[seconds]","<long>");

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

Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/active-configurations",queryParams);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "data": {
//     "attributes": {
//       "active_aggregations": [
//         {
//           "time": "count",
//           "space": "max"
//         },
//         {
//           "time": "sum",
//           "space": "min"
//         }
//       ],
//       "active_tags": [
//         "<string>",
//         "<string>"
//       ]
//     },
//     "id": "<string>",
//     "type": "actively_queried_configurations"
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

string time;
string space;
string strVal;

string Id = jResp.StringOf("data.id");
string v_Type = jResp.StringOf("data.type");
int i = 0;
int count_i = jResp.SizeOfArray("data.attributes.active_aggregations");
while (i < count_i) {
    jResp.I = i;
    time = jResp.StringOf("data.attributes.active_aggregations[i].time");
    space = jResp.StringOf("data.attributes.active_aggregations[i].space");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("data.attributes.active_tags");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("data.attributes.active_tags[i]");
    i = i + 1;
}

Curl Command

curl -G -d "window[seconds]=%3Clong%3E"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/active-configurations

Postman Collection Item JSON

{
  "name": "List active tags and aggregations",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/metrics/:metric_name/active-configurations?window[seconds]=<long>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "metrics",
        ":metric_name",
        "active-configurations"
      ],
      "query": [
        {
          "key": "window[seconds]",
          "value": "<long>",
          "description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
        }
      ],
      "variable": [
        {
          "key": "metric_name",
          "value": "<string>"
        }
      ]
    },
    "description": "List tags and aggregations that are actively queried on dashboards and monitors for a given metric name."
  },
  "response": [
    {
      "name": "Success",
      "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/metrics/:metric_name/active-configurations?window[seconds]=<long>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics",
            ":metric_name",
            "active-configurations"
          ],
          "query": [
            {
              "key": "window[seconds]",
              "value": "<long>",
              "description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
            }
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"attributes\": {\n      \"active_aggregations\": [\n        {\n          \"time\": \"count\",\n          \"space\": \"max\"\n        },\n        {\n          \"time\": \"sum\",\n          \"space\": \"min\"\n        }\n      ],\n      \"active_tags\": [\n        \"<string>\",\n        \"<string>\"\n      ]\n    },\n    \"id\": \"<string>\",\n    \"type\": \"actively_queried_configurations\"\n  }\n}"
    },
    {
      "name": "Bad Request",
      "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/metrics/:metric_name/active-configurations?window[seconds]=<long>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics",
            ":metric_name",
            "active-configurations"
          ],
          "query": [
            {
              "key": "window[seconds]",
              "value": "<long>",
              "description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
            }
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "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": "Forbidden",
      "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/metrics/:metric_name/active-configurations?window[seconds]=<long>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics",
            ":metric_name",
            "active-configurations"
          ],
          "query": [
            {
              "key": "window[seconds]",
              "value": "<long>",
              "description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
            }
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "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/metrics/:metric_name/active-configurations?window[seconds]=<long>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics",
            ":metric_name",
            "active-configurations"
          ],
          "query": [
            {
              "key": "window[seconds]",
              "value": "<long>",
              "description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
            }
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "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/metrics/:metric_name/active-configurations?window[seconds]=<long>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "metrics",
            ":metric_name",
            "active-configurations"
          ],
          "query": [
            {
              "key": "window[seconds]",
              "value": "<long>",
              "description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
            }
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "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}"
    }
  ]
}