Chilkat Online Tools

C++ / Datadog API Collection / Create a span-based metric

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.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;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "data": {
    //     "id": "<string>",
    //     "type": "spans_metrics",
    //     "attributes": {
    //       "compute": {
    //         "aggregation_type": "count",
    //         "include_percentiles": "<boolean>",
    //         "path": "<string>"
    //       },
    //       "filter": {
    //         "query": "*"
    //       },
    //       "group_by": [
    //         {
    //           "path": "<string>",
    //           "tag_name": "<string>"
    //         },
    //         {
    //           "path": "<string>",
    //           "tag_name": "<string>"
    //         }
    //       ]
    //     }
    //   }
    // }

    CkJsonObject json;
    json.UpdateString("data.id","<string>");
    json.UpdateString("data.type","spans_metrics");
    json.UpdateString("data.attributes.compute.aggregation_type","count");
    json.UpdateString("data.attributes.compute.include_percentiles","<boolean>");
    json.UpdateString("data.attributes.compute.path","<string>");
    json.UpdateString("data.attributes.filter.query","*");
    json.UpdateString("data.attributes.group_by[0].path","<string>");
    json.UpdateString("data.attributes.group_by[0].tag_name","<string>");
    json.UpdateString("data.attributes.group_by[1].path","<string>");
    json.UpdateString("data.attributes.group_by[1].tag_name","<string>");

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

    CkHttpResponse *resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/apm/config/metrics","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

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

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

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "data": {
    //     "attributes": {
    //       "compute": {
    //         "aggregation_type": "distribution",
    //         "include_percentiles": "<boolean>",
    //         "path": "<string>"
    //       },
    //       "filter": {
    //         "query": "<string>"
    //       },
    //       "group_by": [
    //         {
    //           "path": "<string>",
    //           "tag_name": "<string>"
    //         },
    //         {
    //           "path": "<string>",
    //           "tag_name": "<string>"
    //         }
    //       ]
    //     },
    //     "id": "<string>",
    //     "type": "spans_metrics"
    //   }
    // }

    // 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 *path = 0;
    const char *tag_name = 0;

    const char *Aggregation_type = jResp.stringOf("data.attributes.compute.aggregation_type");
    const char *Include_percentiles = jResp.stringOf("data.attributes.compute.include_percentiles");
    const char *Path = jResp.stringOf("data.attributes.compute.path");
    const char *Query = jResp.stringOf("data.attributes.filter.query");
    const char *Id = jResp.stringOf("data.id");
    const char *v_Type = jResp.stringOf("data.type");
    int i = 0;
    int count_i = jResp.SizeOfArray("data.attributes.group_by");
    while (i < count_i) {
        jResp.put_I(i);
        path = jResp.stringOf("data.attributes.group_by[i].path");
        tag_name = jResp.stringOf("data.attributes.group_by[i].tag_name");
        i = i + 1;
    }
    }

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "id": "<string>",
    "type": "spans_metrics",
    "attributes": {
      "compute": {
        "aggregation_type": "count",
        "include_percentiles": "<boolean>",
        "path": "<string>"
      },
      "filter": {
        "query": "*"
      },
      "group_by": [
        {
          "path": "<string>",
          "tag_name": "<string>"
        },
        {
          "path": "<string>",
          "tag_name": "<string>"
        }
      ]
    }
  }
}'
https://api.app.ddog-gov.com/api/v2/apm/config/metrics

Postman Collection Item JSON

{
  "name": "Create a span-based metric",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"spans_metrics\",\n    \"attributes\": {\n      \"compute\": {\n        \"aggregation_type\": \"count\",\n        \"include_percentiles\": \"<boolean>\",\n        \"path\": \"<string>\"\n      },\n      \"filter\": {\n        \"query\": \"*\"\n      },\n      \"group_by\": [\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        },\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        }\n      ]\n    }\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/apm/config/metrics",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "apm",
        "config",
        "metrics"
      ]
    },
    "description": "Create a metric based on your ingested spans in your organization.\nReturns the span-based metric object from the request body when the request is successful."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"spans_metrics\",\n    \"attributes\": {\n      \"compute\": {\n        \"aggregation_type\": \"count\",\n        \"include_percentiles\": \"<boolean>\",\n        \"path\": \"<string>\"\n      },\n      \"filter\": {\n        \"query\": \"*\"\n      },\n      \"group_by\": [\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        },\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        }\n      ]\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/apm/config/metrics",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "config",
            "metrics"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"attributes\": {\n      \"compute\": {\n        \"aggregation_type\": \"distribution\",\n        \"include_percentiles\": \"<boolean>\",\n        \"path\": \"<string>\"\n      },\n      \"filter\": {\n        \"query\": \"<string>\"\n      },\n      \"group_by\": [\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        },\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        }\n      ]\n    },\n    \"id\": \"<string>\",\n    \"type\": \"spans_metrics\"\n  }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"spans_metrics\",\n    \"attributes\": {\n      \"compute\": {\n        \"aggregation_type\": \"count\",\n        \"include_percentiles\": \"<boolean>\",\n        \"path\": \"<string>\"\n      },\n      \"filter\": {\n        \"query\": \"*\"\n      },\n      \"group_by\": [\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        },\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        }\n      ]\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/apm/config/metrics",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "config",
            "metrics"
          ]
        }
      },
      "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": "Not Authorized",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"spans_metrics\",\n    \"attributes\": {\n      \"compute\": {\n        \"aggregation_type\": \"count\",\n        \"include_percentiles\": \"<boolean>\",\n        \"path\": \"<string>\"\n      },\n      \"filter\": {\n        \"query\": \"*\"\n      },\n      \"group_by\": [\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        },\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        }\n      ]\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/apm/config/metrics",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "config",
            "metrics"
          ]
        }
      },
      "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": "Conflict",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"spans_metrics\",\n    \"attributes\": {\n      \"compute\": {\n        \"aggregation_type\": \"count\",\n        \"include_percentiles\": \"<boolean>\",\n        \"path\": \"<string>\"\n      },\n      \"filter\": {\n        \"query\": \"*\"\n      },\n      \"group_by\": [\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        },\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        }\n      ]\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/apm/config/metrics",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "config",
            "metrics"
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"spans_metrics\",\n    \"attributes\": {\n      \"compute\": {\n        \"aggregation_type\": \"count\",\n        \"include_percentiles\": \"<boolean>\",\n        \"path\": \"<string>\"\n      },\n      \"filter\": {\n        \"query\": \"*\"\n      },\n      \"group_by\": [\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        },\n        {\n          \"path\": \"<string>\",\n          \"tag_name\": \"<string>\"\n        }\n      ]\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/apm/config/metrics",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "apm",
            "config",
            "metrics"
          ]
        }
      },
      "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}"
    }
  ]
}