Chilkat Online Tools

Ruby / Datadog API Collection / Submit distribution points

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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": "Post time-series data that can be graphed on Datadog’s dashboards.",
#   "externalValue": "examples/metrics/distribution-points.json.sh",
#   "summary": "Dynamic Points",
#   "x-variables": {
#     "NOW": "$(date +%s)"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("description","Post time-series data that can be graphed on Datadog’s dashboards.")
json.UpdateString("externalValue","examples/metrics/distribution-points.json.sh")
json.UpdateString("summary","Dynamic Points")
json.UpdateString("x-variables.NOW","$(date +%s)")

http.SetRequestHeader("Content-Type","text/json")
http.SetRequestHeader("Accept","text/json")
http.SetRequestHeader("Content-Encoding","identity")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v1/distribution_points","text/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "status": "ok"
# }

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

status = jResp.stringOf("status")

Curl Command

curl -X POST
	-H "Content-Encoding: identity"
	-H "Content-Type: text/json"
	-H "Accept: text/json"
	-d '{
  "description": "Post time-series data that can be graphed on Datadog’s dashboards.",
  "externalValue": "examples/metrics/distribution-points.json.sh",
  "summary": "Dynamic Points",
  "x-variables": {
    "NOW": "$(date +%s)"
  }
}'
https://api.app.ddog-gov.com/api/v1/distribution_points

Postman Collection Item JSON

{
  "name": "Submit distribution points",
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "HTTP header used to compress the media-type.",
        "key": "Content-Encoding",
        "value": "identity"
      },
      {
        "key": "Content-Type",
        "value": "text/json"
      },
      {
        "key": "Accept",
        "value": "text/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n  \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n  \"summary\": \"Dynamic Points\",\n  \"x-variables\": {\n    \"NOW\": \"$(date +%s)\"\n  }\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/distribution_points",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "distribution_points"
      ]
    },
    "description": "The distribution points end-point allows you to post distribution data that can be graphed on Datadog’s dashboards."
  },
  "response": [
    {
      "name": "Payload accepted",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "HTTP header used to compress the media-type.",
            "key": "Content-Encoding",
            "value": "deflate"
          },
          {
            "key": "Content-Type",
            "value": "text/json"
          },
          {
            "key": "Accept",
            "value": "text/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n  \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n  \"summary\": \"Dynamic Points\",\n  \"x-variables\": {\n    \"NOW\": \"$(date +%s)\"\n  }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/distribution_points",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "distribution_points"
          ]
        }
      },
      "status": "Accepted",
      "code": 202,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"status\": \"ok\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "HTTP header used to compress the media-type.",
            "key": "Content-Encoding",
            "value": "deflate"
          },
          {
            "key": "Content-Type",
            "value": "text/json"
          },
          {
            "key": "Accept",
            "value": "text/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n  \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n  \"summary\": \"Dynamic Points\",\n  \"x-variables\": {\n    \"NOW\": \"$(date +%s)\"\n  }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/distribution_points",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "distribution_points"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Authentication error",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "HTTP header used to compress the media-type.",
            "key": "Content-Encoding",
            "value": "deflate"
          },
          {
            "key": "Content-Type",
            "value": "text/json"
          },
          {
            "key": "Accept",
            "value": "text/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n  \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n  \"summary\": \"Dynamic Points\",\n  \"x-variables\": {\n    \"NOW\": \"$(date +%s)\"\n  }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/distribution_points",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "distribution_points"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Request timeout",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "HTTP header used to compress the media-type.",
            "key": "Content-Encoding",
            "value": "deflate"
          },
          {
            "key": "Content-Type",
            "value": "text/json"
          },
          {
            "key": "Accept",
            "value": "text/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n  \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n  \"summary\": \"Dynamic Points\",\n  \"x-variables\": {\n    \"NOW\": \"$(date +%s)\"\n  }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/distribution_points",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "distribution_points"
          ]
        }
      },
      "status": "Request Timeout",
      "code": 408,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Payload too large",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "HTTP header used to compress the media-type.",
            "key": "Content-Encoding",
            "value": "deflate"
          },
          {
            "key": "Content-Type",
            "value": "text/json"
          },
          {
            "key": "Accept",
            "value": "text/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n  \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n  \"summary\": \"Dynamic Points\",\n  \"x-variables\": {\n    \"NOW\": \"$(date +%s)\"\n  }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/distribution_points",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "distribution_points"
          ]
        }
      },
      "status": "Request Entity Too Large",
      "code": 413,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "HTTP header used to compress the media-type.",
            "key": "Content-Encoding",
            "value": "deflate"
          },
          {
            "key": "Content-Type",
            "value": "text/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\": \"Post time-series data that can be graphed on Datadog’s dashboards.\",\n  \"externalValue\": \"examples/metrics/distribution-points.json.sh\",\n  \"summary\": \"Dynamic Points\",\n  \"x-variables\": {\n    \"NOW\": \"$(date +%s)\"\n  }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/distribution_points",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "distribution_points"
          ]
        }
      },
      "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}"
    }
  ]
}