--- title: Prendre des snapshots de graphiques description: Prenez des snapshots de graphiques. breadcrumbs: Documentation > API > Prendre des snapshots de graphiques --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Prendre des snapshots de graphiques ## v1 (latest) | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/graph/snapshot | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/graph/snapshot | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/graph/snapshot | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/graph/snapshot | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/graph/snapshot | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/graph/snapshot | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v1/graph/snapshot | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/graph/snapshot | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v1/graph/snapshot | ### Overview Prenez des snapshots de graphiques. Les snapshots correspondent à des images PNG générées en affichant un widget spécifique sur une page web et en capturant le rendu une fois les données disponibles. L'image est ensuite téléchargée vers le stockage cloud. **Remarque** : lorsqu'un snapshot est créé, il n'est pas disponible de suite. ### Arguments #### Query Strings | Field | Type | Description | | ------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | metric_query | string | The metric query. | | start [*required*] | integer | The POSIX timestamp of the start of the query in seconds. | | end [*required*] | integer | The POSIX timestamp of the end of the query in seconds. | | 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](https://docs.datadoghq.com/graphing/graphing_json.md#grammar) 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. | | height | integer | The height of the graph. If no height is specified, the graph's original height is used. | | width | integer | The width of the graph. If no width is specified, the graph's original width is used. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Object representing a graph snapshot. | Field | Type | Description | | ------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 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](https://docs.datadoghq.com/graphing/graphing_json.md#grammar) and should be formatted to a single line then URL encoded. | | metric_query | string | The metric query. One of `metric_query` or `graph_def` is required. | | snapshot_url | string | URL of your [graph snapshot](https://docs.datadoghq.com/metrics/explorer.md#snapshot). | {% /tab %} {% tab label="Example" %} ```json { "graph_def": "string", "metric_query": "string", "snapshot_url": "https://app.datadoghq.com/s/f12345678/aaa-bbb-ccc" } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Required query arguments export metric_query="CHANGE_ME" export start="CHANGE_ME" export end="CHANGE_ME" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v1/graph/snapshot?metric_query=${metric_query}&start=${start}&end=${end}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Take graph snapshots returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "time" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewSnapshotsApi(apiClient) resp, r, err := api.GetGraphSnapshot(ctx, time.Now().AddDate(0, 0, -1).Unix(), time.Now().Unix(), *datadogV1.NewGetGraphSnapshotOptionalParameters().WithMetricQuery("avg:system.load.1{*}").WithTitle("System load").WithHeight(400).WithWidth(600)) 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) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SnapshotsApi.GetGraphSnapshot`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Take graph snapshots returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.SnapshotsApi; import com.datadog.api.client.v1.api.SnapshotsApi.GetGraphSnapshotOptionalParameters; import com.datadog.api.client.v1.model.GraphSnapshot; import java.time.OffsetDateTime; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); SnapshotsApi apiInstance = new SnapshotsApi(defaultClient); try { GraphSnapshot result = apiInstance.getGraphSnapshot( OffsetDateTime.now().plusDays(-1).toInstant().getEpochSecond(), OffsetDateTime.now().toInstant().getEpochSecond(), new GetGraphSnapshotOptionalParameters() .metricQuery("avg:system.load.1{*}") .title("System load") .height(400L) .width(600L)); 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(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Take graph snapshots returns "OK" response """ from datetime import datetime from dateutil.relativedelta import relativedelta from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.snapshots_api import SnapshotsApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = SnapshotsApi(api_client) response = api_instance.get_graph_snapshot( metric_query="avg:system.load.1{*}", start=int((datetime.now() + relativedelta(days=-1)).timestamp()), end=int(datetime.now().timestamp()), title="System load", height=400, width=600, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Take graph snapshots returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V1::SnapshotsAPI.new opts = { metric_query: "avg:system.load.1{*}", title: "System load", height: 400, width: 600, } p api_instance.get_graph_snapshot((Time.now + -1 * 86400).to_i, Time.now.to_i, opts) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Take graph snapshots returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_snapshots::GetGraphSnapshotOptionalParams; use datadog_api_client::datadogV1::api_snapshots::SnapshotsAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = SnapshotsAPI::with_config(configuration); let resp = api .get_graph_snapshot( 1636542671, 1636629071, GetGraphSnapshotOptionalParams::default() .metric_query("avg:system.load.1{*}".to_string()) .title("System load".to_string()) .height(400) .width(600), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Take graph snapshots returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v1.SnapshotsApi(configuration); const params: v1.SnapshotsApiGetGraphSnapshotRequest = { metricQuery: "avg:system.load.1{*}", start: Math.round( new Date(new Date().getTime() + -1 * 86400 * 1000).getTime() / 1000 ), end: Math.round(new Date().getTime() / 1000), title: "System load", height: 400, width: 600, }; apiInstance .getGraphSnapshot(params) .then((data: v1.GraphSnapshot) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% tab label="Python [legacy]" %} ```python from datadog import initialize, api import time options = { 'api_key': '', 'app_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 ) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python-legacy) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python "example.py" ``` {% /tab %} {% tab label="Ruby [legacy]" %} ```ruby require 'rubygems' require 'dogapi' api_key = '' app_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) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ``` {% /tab %} {% /tabs %}