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()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("metric_query","tempor Ut sed velit")
queryParams.UpdateInt("start",-62147425)
queryParams.UpdateInt("end",-62147425)
queryParams.UpdateString("event_query","tempor Ut sed velit")
queryParams.UpdateString("graph_def","tempor Ut sed velit")
queryParams.UpdateString("title","tempor Ut sed velit")
queryParams.UpdateInt("height",-62147425)
queryParams.UpdateInt("width",-62147425)
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/graph/snapshot",queryParams)
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)
# {
# "graph_def": "aliquip pariatur non",
# "metric_query": "sit veniam dolore Ut",
# "snapshot_url": "https://app.datadoghq.com/s/f12345678/aaa-bbb-ccc"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
graph_def = jResp.stringOf("graph_def")
metric_query = jResp.stringOf("metric_query")
snapshot_url = jResp.stringOf("snapshot_url")
Curl Command
curl -G -d "metric_query=tempor%20Ut%20sed%20velit"
-d "start=-62147425"
-d "end=-62147425"
-d "event_query=tempor%20Ut%20sed%20velit"
-d "graph_def=tempor%20Ut%20sed%20velit"
-d "title=tempor%20Ut%20sed%20velit"
-d "height=-62147425"
-d "width=-62147425"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/graph/snapshot
Postman Collection Item JSON
{
"name": "Take graph snapshots",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/graph/snapshot?metric_query=tempor Ut sed velit&start=-62147425&end=-62147425&event_query=tempor Ut sed velit&graph_def=tempor Ut sed velit&title=tempor Ut sed velit&height=-62147425&width=-62147425",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"snapshot"
],
"query": [
{
"key": "metric_query",
"value": "tempor Ut sed velit",
"description": "The metric query."
},
{
"key": "start",
"value": "-62147425",
"description": "(Required) The POSIX timestamp of the start of the query in seconds."
},
{
"key": "end",
"value": "-62147425",
"description": "(Required) The POSIX timestamp of the end of the query in seconds."
},
{
"key": "event_query",
"value": "tempor Ut sed velit",
"description": "A query that adds event bands to the graph."
},
{
"key": "graph_def",
"value": "tempor Ut sed velit",
"description": "A JSON document defining the graph. `graph_def` can be used instead of `metric_query`.\nThe JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar)\nand should be formatted to a single line then URL encoded."
},
{
"key": "title",
"value": "tempor Ut sed velit",
"description": "A title for the graph. If no title is specified, the graph does not have a title."
},
{
"key": "height",
"value": "-62147425",
"description": "The height of the graph. If no height is specified, the graph's original height is used."
},
{
"key": "width",
"value": "-62147425",
"description": "The width of the graph. If no width is specified, the graph's original width is used."
}
]
},
"description": "Take graph snapshots.\n**Note**: When a snapshot is created, there is some delay before it is available."
},
"response": [
{
"name": "OK",
"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/v1/graph/snapshot?metric_query=tempor Ut sed velit&start=-62147425&end=-62147425&event_query=tempor Ut sed velit&graph_def=tempor Ut sed velit&title=tempor Ut sed velit&height=-62147425&width=-62147425",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"snapshot"
],
"query": [
{
"key": "metric_query",
"value": "tempor Ut sed velit",
"description": "The metric query."
},
{
"key": "start",
"value": "-62147425",
"description": "(Required) The POSIX timestamp of the start of the query in seconds."
},
{
"key": "end",
"value": "-62147425",
"description": "(Required) The POSIX timestamp of the end of the query in seconds."
},
{
"key": "event_query",
"value": "tempor Ut sed velit",
"description": "A query that adds event bands to the graph."
},
{
"key": "graph_def",
"value": "tempor Ut sed velit",
"description": "A JSON document defining the graph. `graph_def` can be used instead of `metric_query`.\nThe JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar)\nand should be formatted to a single line then URL encoded."
},
{
"key": "title",
"value": "tempor Ut sed velit",
"description": "A title for the graph. If no title is specified, the graph does not have a title."
},
{
"key": "height",
"value": "-62147425",
"description": "The height of the graph. If no height is specified, the graph's original height is used."
},
{
"key": "width",
"value": "-62147425",
"description": "The width of the graph. If no width is specified, the graph's original width is used."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"graph_def\": \"aliquip pariatur non\",\n \"metric_query\": \"sit veniam dolore Ut\",\n \"snapshot_url\": \"https://app.datadoghq.com/s/f12345678/aaa-bbb-ccc\"\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/v1/graph/snapshot?metric_query=tempor Ut sed velit&start=-62147425&end=-62147425&event_query=tempor Ut sed velit&graph_def=tempor Ut sed velit&title=tempor Ut sed velit&height=-62147425&width=-62147425",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"snapshot"
],
"query": [
{
"key": "metric_query",
"value": "tempor Ut sed velit",
"description": "The metric query."
},
{
"key": "start",
"value": "-62147425",
"description": "(Required) The POSIX timestamp of the start of the query in seconds."
},
{
"key": "end",
"value": "-62147425",
"description": "(Required) The POSIX timestamp of the end of the query in seconds."
},
{
"key": "event_query",
"value": "tempor Ut sed velit",
"description": "A query that adds event bands to the graph."
},
{
"key": "graph_def",
"value": "tempor Ut sed velit",
"description": "A JSON document defining the graph. `graph_def` can be used instead of `metric_query`.\nThe JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar)\nand should be formatted to a single line then URL encoded."
},
{
"key": "title",
"value": "tempor Ut sed velit",
"description": "A title for the graph. If no title is specified, the graph does not have a title."
},
{
"key": "height",
"value": "-62147425",
"description": "The height of the graph. If no height is specified, the graph's original height is used."
},
{
"key": "width",
"value": "-62147425",
"description": "The width of the graph. If no width is specified, the graph's original width is used."
}
]
}
},
"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": "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/v1/graph/snapshot?metric_query=tempor Ut sed velit&start=-62147425&end=-62147425&event_query=tempor Ut sed velit&graph_def=tempor Ut sed velit&title=tempor Ut sed velit&height=-62147425&width=-62147425",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"snapshot"
],
"query": [
{
"key": "metric_query",
"value": "tempor Ut sed velit",
"description": "The metric query."
},
{
"key": "start",
"value": "-62147425",
"description": "(Required) The POSIX timestamp of the start of the query in seconds."
},
{
"key": "end",
"value": "-62147425",
"description": "(Required) The POSIX timestamp of the end of the query in seconds."
},
{
"key": "event_query",
"value": "tempor Ut sed velit",
"description": "A query that adds event bands to the graph."
},
{
"key": "graph_def",
"value": "tempor Ut sed velit",
"description": "A JSON document defining the graph. `graph_def` can be used instead of `metric_query`.\nThe JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar)\nand should be formatted to a single line then URL encoded."
},
{
"key": "title",
"value": "tempor Ut sed velit",
"description": "A title for the graph. If no title is specified, the graph does not have a title."
},
{
"key": "height",
"value": "-62147425",
"description": "The height of the graph. If no height is specified, the graph's original height is used."
},
{
"key": "width",
"value": "-62147425",
"description": "The width of the graph. If no width is specified, the graph's original width is used."
}
]
}
},
"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": "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/v1/graph/snapshot?metric_query=tempor Ut sed velit&start=-62147425&end=-62147425&event_query=tempor Ut sed velit&graph_def=tempor Ut sed velit&title=tempor Ut sed velit&height=-62147425&width=-62147425",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"graph",
"snapshot"
],
"query": [
{
"key": "metric_query",
"value": "tempor Ut sed velit",
"description": "The metric query."
},
{
"key": "start",
"value": "-62147425",
"description": "(Required) The POSIX timestamp of the start of the query in seconds."
},
{
"key": "end",
"value": "-62147425",
"description": "(Required) The POSIX timestamp of the end of the query in seconds."
},
{
"key": "event_query",
"value": "tempor Ut sed velit",
"description": "A query that adds event bands to the graph."
},
{
"key": "graph_def",
"value": "tempor Ut sed velit",
"description": "A JSON document defining the graph. `graph_def` can be used instead of `metric_query`.\nThe JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar)\nand should be formatted to a single line then URL encoded."
},
{
"key": "title",
"value": "tempor Ut sed velit",
"description": "A title for the graph. If no title is specified, the graph does not have a title."
},
{
"key": "height",
"value": "-62147425",
"description": "The height of the graph. If no height is specified, the graph's original height is used."
},
{
"key": "width",
"value": "-62147425",
"description": "The width of the graph. If no width is specified, the graph's original width is used."
}
]
}
},
"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}"
}
]
}
