Chilkat Online Tools

phpExt / Datadog API Collection / Edit metric metadata

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

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

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

// {
//   "description": "exercitation ea ullamco occaecat",
//   "integration": "nulla aute in",
//   "per_unit": "second",
//   "short_name": "exercitation et proident do",
//   "statsd_interval": 33065337,
//   "type": "count",
//   "unit": "byte"
// }

$json = new CkJsonObject();
$json->UpdateString('description','exercitation ea ullamco occaecat');
$json->UpdateString('integration','nulla aute in');
$json->UpdateString('per_unit','second');
$json->UpdateString('short_name','exercitation et proident do');
$json->UpdateInt('statsd_interval',33065337);
$json->UpdateString('type','count');
$json->UpdateString('unit','byte');

$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept','application/json');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://api.app.ddog-gov.com/api/v1/metrics/:metric_name',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

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

// {
//   "description": "exercitation ea ullamco occaecat",
//   "integration": "nulla aute in",
//   "per_unit": "second",
//   "short_name": "exercitation et proident do",
//   "statsd_interval": 33065337,
//   "type": "count",
//   "unit": "byte"
// }

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

$description = $jResp->stringOf('description');
$integration = $jResp->stringOf('integration');
$per_unit = $jResp->stringOf('per_unit');
$short_name = $jResp->stringOf('short_name');
$statsd_interval = $jResp->IntOf('statsd_interval');
$v_type = $jResp->stringOf('type');
$unit = $jResp->stringOf('unit');

?>

Curl Command

curl -X PUT
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "description": "exercitation ea ullamco occaecat",
  "integration": "nulla aute in",
  "per_unit": "second",
  "short_name": "exercitation et proident do",
  "statsd_interval": 33065337,
  "type": "count",
  "unit": "byte"
}'
https://api.app.ddog-gov.com/api/v1/metrics/:metric_name

Postman Collection Item JSON

{
  "name": "Edit metric metadata",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"description\": \"exercitation ea ullamco occaecat\",\n  \"integration\": \"nulla aute in\",\n  \"per_unit\": \"second\",\n  \"short_name\": \"exercitation et proident do\",\n  \"statsd_interval\": 33065337,\n  \"type\": \"count\",\n  \"unit\": \"byte\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "metrics",
        ":metric_name"
      ],
      "variable": [
        {
          "key": "metric_name",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Edit metadata of a specific metric. Find out more about [supported types](https://docs.datadoghq.com/developers/metrics)."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "PUT",
        "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  \"description\": \"exercitation ea ullamco occaecat\",\n  \"integration\": \"nulla aute in\",\n  \"per_unit\": \"second\",\n  \"short_name\": \"exercitation et proident do\",\n  \"statsd_interval\": 33065337,\n  \"type\": \"count\",\n  \"unit\": \"byte\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "metrics",
            ":metric_name"
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"description\": \"exercitation ea ullamco occaecat\",\n  \"integration\": \"nulla aute in\",\n  \"per_unit\": \"second\",\n  \"short_name\": \"exercitation et proident do\",\n  \"statsd_interval\": 33065337,\n  \"type\": \"count\",\n  \"unit\": \"byte\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "PUT",
        "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  \"description\": \"exercitation ea ullamco occaecat\",\n  \"integration\": \"nulla aute in\",\n  \"per_unit\": \"second\",\n  \"short_name\": \"exercitation et proident do\",\n  \"statsd_interval\": 33065337,\n  \"type\": \"count\",\n  \"unit\": \"byte\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "metrics",
            ":metric_name"
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "PUT",
        "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  \"description\": \"exercitation ea ullamco occaecat\",\n  \"integration\": \"nulla aute in\",\n  \"per_unit\": \"second\",\n  \"short_name\": \"exercitation et proident do\",\n  \"statsd_interval\": 33065337,\n  \"type\": \"count\",\n  \"unit\": \"byte\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "metrics",
            ":metric_name"
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "PUT",
        "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  \"description\": \"exercitation ea ullamco occaecat\",\n  \"integration\": \"nulla aute in\",\n  \"per_unit\": \"second\",\n  \"short_name\": \"exercitation et proident do\",\n  \"statsd_interval\": 33065337,\n  \"type\": \"count\",\n  \"unit\": \"byte\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "metrics",
            ":metric_name"
          ],
          "variable": [
            {
              "key": "metric_name"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "PUT",
        "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  \"description\": \"exercitation ea ullamco occaecat\",\n  \"integration\": \"nulla aute in\",\n  \"per_unit\": \"second\",\n  \"short_name\": \"exercitation et proident do\",\n  \"statsd_interval\": 33065337,\n  \"type\": \"count\",\n  \"unit\": \"byte\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "metrics",
            ":metric_name"
          ],
          "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    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}