Take graph snapshots using the API.
get https://api.datadoghq.comhttps://api.datadoghq.eu/api/v1/graph/snapshot
Take graph snapshots. Note: When a snapshot is created, there is some delay before it is available.
Name
Type
Description
metric_query [required]
string
The metric query.
start [required]
integer
The POSIX timestamp of the start of the query.
end [required]
integer
The POSIX timestamp of the end of the query.
event_query
string
A query that adds event bands to the graph.
graph_def
string
A JSON document defining the graph. graph_def can be used instead of metric_query.
The JSON document uses the grammar defined here
and should be formatted to a single line then URL encoded.
title
string
A title for the graph. If no title is specified, the graph does not have a title.
OK
Object representing a graph snapshot.
{
"graph_def": "string",
"metric_query": "string",
"snapshot_url": "https://app.datadoghq.com/s/f12345678/aaa-bbb-ccc"
}Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}
# Required query arguments
export start="CHANGE_ME"
export end="CHANGE_ME"
# Curl command
curl -X get https://api.datadoghq.comhttps://api.datadoghq.eu/api/v1/graph/snapshot?start=${start}&end=${end} \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}"
package main
import (
"context"
"fmt"
"os"
datadog "github.com/DataDog/datadog-api-client-go/api/v1/datadog"
)
func main() {
ctx := context.WithValue(
context.Background(),
datadog.ContextAPIKeys,
map[string]datadog.APIKey{
"apiKeyAuth": {
Key: os.Getenv("DD_CLIENT_API_KEY"),
},
"appKeyAuth": {
Key: os.Getenv("DD_CLIENT_APP_KEY"),
},
},
)
start := 987 // int64 | The POSIX timestamp of the start of the query.
end := 987 // int64 | The POSIX timestamp of the end of the query.
metricQuery := "metricQuery_example" // string | The metric query. (optional)
eventQuery := "eventQuery_example" // string | A query that adds event bands to the graph. (optional)
graphDef := "graphDef_example" // string | A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar) and should be formatted to a single line then URL encoded. (optional)
title := "title_example" // string | A title for the graph. If no title is specified, the graph does not have a title. (optional)
configuration := datadog.NewConfiguration()
api_client := datadog.NewAPIClient(configuration)
resp, r, err := api_client.SnapshotsApi.GetGraphSnapshot(ctx, start, end).MetricQuery(metricQuery).EventQuery(eventQuery).GraphDef(graphDef).Title(title).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SnapshotsApi.GetGraphSnapshot``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGraphSnapshot`: GraphSnapshot
fmt.Fprintf(os.Stdout, "Response from `SnapshotsApi.GetGraphSnapshot`: %v\n", resp)
}
// Import classes:
import com.datadog.api.v1.client.ApiClient;
import com.datadog.api.v1.client.ApiException;
import com.datadog.api.v1.client.Configuration;
import com.datadog.api.v1.client.auth.*;
import com.datadog.api.v1.client.models.*;
import com.datadog.api.v1.client.api.SnapshotsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure the Datadog site to send API calls to
HashMap<String, String> serverVariables = new HashMap<String, String>();
String site = System.getenv("DD_SITE");
if (site != null) {
serverVariables.put("site", site);
defaultClient.setServerVariables(serverVariables);
}
// Configure API key authorization:
HashMap<String, String> secrets = new HashMap<String, String>();
secrets.put("apiKeyAuth", System.getenv("DD_CLIENT_API_KEY"));
secrets.put("appKeyAuth", System.getenv("DD_CLIENT_APP_KEY"));
defaultClient.configureApiKeys(secrets);
SnapshotsApi apiInstance = new SnapshotsApi(defaultClient);
Long start = 56L; // Long | The POSIX timestamp of the start of the query.
Long end = 56L; // Long | The POSIX timestamp of the end of the query.
String metricQuery = "metricQuery_example"; // String | The metric query.
String eventQuery = "eventQuery_example"; // String | A query that adds event bands to the graph.
String graphDef = "graphDef_example"; // String | A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar) and should be formatted to a single line then URL encoded.
String title = "title_example"; // String | A title for the graph. If no title is specified, the graph does not have a title.
try {
GraphSnapshot result = api.getGraphSnapshot()
.start(start)
.end(end)
.metricQuery(metricQuery)
.eventQuery(eventQuery)
.graphDef(graphDef)
.title(title)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SnapshotsApi#getGraphSnapshot");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
from datadog import initialize, api
import time
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
# Take a graph snapshot
end = int(time.time())
start = end - (60 * 60)
api.Graph.create(
graph_def='{\
"viz": "timeseries", \
"requests": [ \
{"q": "avg:system.load.1{*}", "conditional_formats": [], "type": "line"},\
{"q": "avg:system.load.5{*}", "type": "line"}, \
{"q": "avg:system.load.15{*}", "type": "line"}\
], \
"events": [\
{"q": "hosts:* ", "tags_execution": "and"}\
]}',
start=start,
end=end
)
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
end_ts = Time.now().to_i
start_ts = end_ts - (60 * 60)
dog.graph_snapshot("system.load.1{*}", start_ts, end_ts)