Chilkat Online Tools

Swift / Datadog API Collection / Edit metric metadata

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    let json = CkoJsonObject()
    json.UpdateString("description", value: "exercitation ea ullamco occaecat")
    json.UpdateString("integration", value: "nulla aute in")
    json.UpdateString("per_unit", value: "second")
    json.UpdateString("short_name", value: "exercitation et proident do")
    json.UpdateInt("statsd_interval", value: 33065337)
    json.UpdateString("type", value: "count")
    json.UpdateString("unit", value: "byte")

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

    let sbRequestBody = CkoStringBuilder()
    json.EmitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.PTextSb("PUT", url: "https://api.app.ddog-gov.com/api/v1/metrics/:metric_name", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var description: String? = jResp.StringOf("description")
    var integration: String? = jResp.StringOf("integration")
    var per_unit: String? = jResp.StringOf("per_unit")
    var short_name: String? = jResp.StringOf("short_name")
    var statsd_interval: Int = jResp.IntOf("statsd_interval").intValue
    var v_type: String? = jResp.StringOf("type")
    var unit: String? = 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}"
    }
  ]
}