--- title: Submit metrics description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Metrics --- # Submit metrics{% #submit-metrics %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------ | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/series | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/series | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/series | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/series | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/series | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/series | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/series | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/series | ### Overview The metrics end-point allows you to post time-series data that can be graphed on Datadog's dashboards. The maximum payload size is 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed size of less than 5 megabytes (5242880 bytes). If you're submitting metrics directly to the Datadog API without using DogStatsD, expect: - 64 bits for the timestamp - 64 bits for the value - 20 bytes for the metric names - 50 bytes for the timeseries - The full payload is approximately 100 bytes. Host name is one of the resources in the Resources field. ### Arguments #### Header Parameters | Name | Type | Description | | ---------------- | ------ | -------------------------------------------- | | Content-Encoding | string | HTTP header used to compress the media-type. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | series [*required*] | [object] | A list of timeseries to submit to Datadog. | | series | interval | int64 | If the type of the metric is rate or count, define the corresponding interval in seconds. | | series | metadata | object | Metadata for the metric. | | metadata | origin | object | Metric origin information. | | origin | metric_type | int32 | The origin metric type code | | origin | product | int32 | The origin product code | | origin | service | int32 | The origin service code | | series | metric [*required*] | string | The name of the timeseries. | | series | points [*required*] | [object] | Points relating to a metric. All points must be objects with timestamp and a scalar value (cannot be a string). Timestamps should be in POSIX time in seconds, and cannot be more than ten minutes in the future or more than one hour in the past. | | points | timestamp | int64 | The timestamp should be in seconds and current. Current is defined as not more than 10 minutes in the future or more than 1 hour in the past. | | points | value | double | The numeric value format should be a 64bit float gauge-type value. | | series | resources | [object] | A list of resources to associate with this metric. | | resources | name | string | The name of the resource. | | resources | type | string | The type of the resource. | | series | source_type_name | string | The source type name. | | series | tags | [string] | A list of tags associated with the metric. | | series | type | enum | The type of metric. The available types are `0` (unspecified), `1` (count), `2` (rate), and `3` (gauge). Allowed enum values: `0,1,2,3` | | series | unit | string | The unit of point value. | {% /tab %} {% tab title="Example" %} ##### ```json { "series": [ { "metric": "system.load.1", "type": 0, "points": [ { "timestamp": 1636629071, "value": 0.7 } ], "resources": [ { "name": "dummyhost", "type": "host" } ] } ] } ``` ##### ```json { "series": [ { "metric": "system.load.1", "type": 0, "points": [ { "timestamp": 1636629071, "value": 0.7 } ] } ] } ``` {% /tab %} ### Response {% tab title="202" %} Payload accepted {% tab title="Model" %} The payload accepted for intake. | Field | Type | Description | | ------ | -------- | ----------------- | | errors | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authentication error {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="408" %} Request timeout {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="413" %} Payload too large {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/series" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -d @- << EOF { "series": [ { "metric": "system.load.1", "points": [ { "timestamp": 1636629071, "value": 1.1 } ], "resources": [ { "name": "dummyhost", "type": "host" } ], "type": 0 } ] } EOF \## Dynamic Points # Post time-series data that can be graphed on Datadog's dashboards. \# Template variables export NOW="$(date +%s)" \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/series" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -d @- << EOF { "series": [ { "metric": "system.load.1", "type": 0, "points": [ { "timestamp": 1636629071, "value": 0.7 } ], "resources": [ { "name": "dummyhost", "type": "host" } ] } ] } EOF ##### \## default # See one of the other client libraries for an example of sending deflate-compressed data. \## Dynamic Points # Post time-series data that can be graphed on Datadog's dashboards. See one of the other client libraries for an example of sending deflate-compressed data. ##### ```go // Submit metrics returns "Payload accepted" 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/datadogV2" ) func main() { body := datadogV2.MetricPayload{ Series: []datadogV2.MetricSeries{ { Metric: "system.load.1", Type: datadogV2.METRICINTAKETYPE_UNSPECIFIED.Ptr(), Points: []datadogV2.MetricPoint{ { Timestamp: datadog.PtrInt64(time.Now().Unix()), Value: datadog.PtrFloat64(0.7), }, }, Resources: []datadogV2.MetricResource{ { Name: datadog.PtrString("dummyhost"), Type: datadog.PtrString("host"), }, }, }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewMetricsApi(apiClient) resp, r, err := api.SubmitMetrics(ctx, body, *datadogV2.NewSubmitMetricsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.SubmitMetrics`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `MetricsApi.SubmitMetrics`:\n%s\n", responseContent) } ``` ##### ```go // Submit metrics with compression returns "Payload accepted" 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/datadogV2" ) func main() { body := datadogV2.MetricPayload{ Series: []datadogV2.MetricSeries{ { Metric: "system.load.1", Type: datadogV2.METRICINTAKETYPE_UNSPECIFIED.Ptr(), Points: []datadogV2.MetricPoint{ { Timestamp: datadog.PtrInt64(time.Now().Unix()), Value: datadog.PtrFloat64(0.7), }, }, }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewMetricsApi(apiClient) resp, r, err := api.SubmitMetrics(ctx, body, *datadogV2.NewSubmitMetricsOptionalParameters().WithContentEncoding(datadogV2.METRICCONTENTENCODING_ZSTD1)) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.SubmitMetrics`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `MetricsApi.SubmitMetrics`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" go run "main.go" ##### ```java // Submit metrics returns "Payload accepted" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.MetricsApi; import com.datadog.api.client.v2.model.IntakePayloadAccepted; import com.datadog.api.client.v2.model.MetricIntakeType; import com.datadog.api.client.v2.model.MetricPayload; import com.datadog.api.client.v2.model.MetricPoint; import com.datadog.api.client.v2.model.MetricResource; import com.datadog.api.client.v2.model.MetricSeries; import java.time.OffsetDateTime; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); MetricsApi apiInstance = new MetricsApi(defaultClient); MetricPayload body = new MetricPayload() .series( Collections.singletonList( new MetricSeries() .metric("system.load.1") .type(MetricIntakeType.UNSPECIFIED) .points( Collections.singletonList( new MetricPoint() .timestamp(OffsetDateTime.now().toInstant().getEpochSecond()) .value(0.7))) .resources( Collections.singletonList( new MetricResource().name("dummyhost").type("host"))))); try { IntakePayloadAccepted result = apiInstance.submitMetrics(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MetricsApi#submitMetrics"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ##### ```java // Submit metrics with compression returns "Payload accepted" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.MetricsApi; import com.datadog.api.client.v2.api.MetricsApi.SubmitMetricsOptionalParameters; import com.datadog.api.client.v2.model.IntakePayloadAccepted; import com.datadog.api.client.v2.model.MetricContentEncoding; import com.datadog.api.client.v2.model.MetricIntakeType; import com.datadog.api.client.v2.model.MetricPayload; import com.datadog.api.client.v2.model.MetricPoint; import com.datadog.api.client.v2.model.MetricSeries; import java.time.OffsetDateTime; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); MetricsApi apiInstance = new MetricsApi(defaultClient); MetricPayload body = new MetricPayload() .series( Collections.singletonList( new MetricSeries() .metric("system.load.1") .type(MetricIntakeType.UNSPECIFIED) .points( Collections.singletonList( new MetricPoint() .timestamp(OffsetDateTime.now().toInstant().getEpochSecond()) .value(0.7))))); try { IntakePayloadAccepted result = apiInstance.submitMetrics( body, new SubmitMetricsOptionalParameters().contentEncoding(MetricContentEncoding.ZSTD1)); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MetricsApi#submitMetrics"); 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://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" java "Example.java" ##### ```python """ Submit metrics returns "Payload accepted" response """ from datetime import datetime from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.metrics_api import MetricsApi from datadog_api_client.v2.model.metric_intake_type import MetricIntakeType from datadog_api_client.v2.model.metric_payload import MetricPayload from datadog_api_client.v2.model.metric_point import MetricPoint from datadog_api_client.v2.model.metric_resource import MetricResource from datadog_api_client.v2.model.metric_series import MetricSeries body = MetricPayload( series=[ MetricSeries( metric="system.load.1", type=MetricIntakeType.UNSPECIFIED, points=[ MetricPoint( timestamp=int(datetime.now().timestamp()), value=0.7, ), ], resources=[ MetricResource( name="dummyhost", type="host", ), ], ), ], ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = MetricsApi(api_client) response = api_instance.submit_metrics(body=body) print(response) ``` ##### ```python """ Submit metrics with compression returns "Payload accepted" response """ from datetime import datetime from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.metrics_api import MetricsApi from datadog_api_client.v2.model.metric_content_encoding import MetricContentEncoding from datadog_api_client.v2.model.metric_intake_type import MetricIntakeType from datadog_api_client.v2.model.metric_payload import MetricPayload from datadog_api_client.v2.model.metric_point import MetricPoint from datadog_api_client.v2.model.metric_series import MetricSeries body = MetricPayload( series=[ MetricSeries( metric="system.load.1", type=MetricIntakeType.UNSPECIFIED, points=[ MetricPoint( timestamp=int(datetime.now().timestamp()), value=0.7, ), ], ), ], ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = MetricsApi(api_client) response = api_instance.submit_metrics(content_encoding=MetricContentEncoding.ZSTD1, body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" python3 "example.py" ##### ```ruby # Submit metrics returns "Payload accepted" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::MetricsAPI.new body = DatadogAPIClient::V2::MetricPayload.new({ series: [ DatadogAPIClient::V2::MetricSeries.new({ metric: "system.load.1", type: DatadogAPIClient::V2::MetricIntakeType::UNSPECIFIED, points: [ DatadogAPIClient::V2::MetricPoint.new({ timestamp: Time.now.to_i, value: 0.7, }), ], resources: [ DatadogAPIClient::V2::MetricResource.new({ name: "dummyhost", type: "host", }), ], }), ], }) p api_instance.submit_metrics(body) ``` ##### ```ruby # Submit metrics with compression returns "Payload accepted" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::MetricsAPI.new body = DatadogAPIClient::V2::MetricPayload.new({ series: [ DatadogAPIClient::V2::MetricSeries.new({ metric: "system.load.1", type: DatadogAPIClient::V2::MetricIntakeType::UNSPECIFIED, points: [ DatadogAPIClient::V2::MetricPoint.new({ timestamp: Time.now.to_i, value: 0.7, }), ], }), ], }) opts = { content_encoding: MetricContentEncoding::ZSTD1, } p api_instance.submit_metrics(body, opts) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" rb "example.rb" ##### ```rust // Submit metrics returns "Payload accepted" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_metrics::MetricsAPI; use datadog_api_client::datadogV2::api_metrics::SubmitMetricsOptionalParams; use datadog_api_client::datadogV2::model::MetricIntakeType; use datadog_api_client::datadogV2::model::MetricPayload; use datadog_api_client::datadogV2::model::MetricPoint; use datadog_api_client::datadogV2::model::MetricResource; use datadog_api_client::datadogV2::model::MetricSeries; #[tokio::main] async fn main() { let body = MetricPayload::new(vec![MetricSeries::new( "system.load.1".to_string(), vec![MetricPoint::new().timestamp(1636629071).value(0.7 as f64)], ) .resources(vec![MetricResource::new() .name("dummyhost".to_string()) .type_("host".to_string())]) .type_(MetricIntakeType::UNSPECIFIED)]); let configuration = datadog::Configuration::new(); let api = MetricsAPI::with_config(configuration); let resp = api .submit_metrics(body, SubmitMetricsOptionalParams::default()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` ##### ```rust // Submit metrics with compression returns "Payload accepted" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_metrics::MetricsAPI; use datadog_api_client::datadogV2::api_metrics::SubmitMetricsOptionalParams; use datadog_api_client::datadogV2::model::MetricContentEncoding; use datadog_api_client::datadogV2::model::MetricIntakeType; use datadog_api_client::datadogV2::model::MetricPayload; use datadog_api_client::datadogV2::model::MetricPoint; use datadog_api_client::datadogV2::model::MetricSeries; #[tokio::main] async fn main() { let body = MetricPayload::new(vec![MetricSeries::new( "system.load.1".to_string(), vec![MetricPoint::new().timestamp(1636629071).value(0.7 as f64)], ) .type_(MetricIntakeType::UNSPECIFIED)]); let configuration = datadog::Configuration::new(); let api = MetricsAPI::with_config(configuration); let resp = api .submit_metrics( body, SubmitMetricsOptionalParams::default().content_encoding(MetricContentEncoding::ZSTD1), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" cargo run ##### ```typescript /** * Submit metrics returns "Payload accepted" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.MetricsApi(configuration); const params: v2.MetricsApiSubmitMetricsRequest = { body: { series: [ { metric: "system.load.1", type: 0, points: [ { timestamp: Math.round(new Date().getTime() / 1000), value: 0.7, }, ], resources: [ { name: "dummyhost", type: "host", }, ], }, ], }, }; apiInstance .submitMetrics(params) .then((data: v2.IntakePayloadAccepted) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` ##### ```typescript /** * Submit metrics with compression returns "Payload accepted" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.MetricsApi(configuration); const params: v2.MetricsApiSubmitMetricsRequest = { body: { series: [ { metric: "system.load.1", type: 0, points: [ { timestamp: Math.round(new Date().getTime() / 1000), value: 0.7, }, ], }, ], }, contentEncoding: "zstd1", }; apiInstance .submitMetrics(params) .then((data: v2.IntakePayloadAccepted) => { 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://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" tsc "example.ts" {% /tab %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------ | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v1/series | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v1/series | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v1/series | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v1/series | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v1/series | | app.datadoghq.com | POST https://api.datadoghq.com/api/v1/series | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v1/series | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v1/series | ### Overview The metrics end-point allows you to post time-series data that can be graphed on Datadog's dashboards. The maximum payload size is 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed size of less than 62 megabytes (62914560 bytes). If you're submitting metrics directly to the Datadog API without using DogStatsD, expect: - 64 bits for the timestamp - 64 bits for the value - 40 bytes for the metric names - 50 bytes for the timeseries - The full payload is approximately 100 bytes. However, with the DogStatsD API, compression is applied, which reduces the payload size. ### Arguments #### Header Parameters | Name | Type | Description | | ---------------- | ------ | -------------------------------------------- | | Content-Encoding | string | HTTP header used to compress the media-type. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | series [*required*] | [object] | A list of timeseries to submit to Datadog. | | series | host | string | The name of the host that produced the metric. | | series | interval | int64 | If the type of the metric is rate or count, define the corresponding interval in seconds. | | series | metric [*required*] | string | The name of the timeseries. | | series | points [*required*] | [array] | Points relating to a metric. All points must be tuples with timestamp and a scalar value (cannot be a string). Timestamps should be in POSIX time in seconds, and cannot be more than ten minutes in the future or more than one hour in the past. | | series | tags | [string] | A list of tags associated with the metric. | | series | type | string | The type of the metric. Valid types are "",`count`, `gauge`, and `rate`. | {% /tab %} {% tab title="Example" %} ##### ```json { "series": [ { "metric": "system.load.1", "type": "gauge", "points": [ [ 1636629071, 1.1 ] ], "tags": [ "test:ExampleMetric" ] } ] } ``` ##### ```json { "series": [ { "metric": "system.load.1", "type": "gauge", "points": [ [ 1636629071, 1.1 ] ], "tags": [ "test:ExampleMetric" ] } ] } ``` {% /tab %} ### Response {% tab title="202" %} Payload accepted {% tab title="Model" %} The payload accepted for intake. | Field | Type | Description | | ------ | ------ | --------------------------------- | | status | string | The status of the intake payload. | {% /tab %} {% tab title="Example" %} ```json { "status": "ok" } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authentication error {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="408" %} Request timeout {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="413" %} Payload too large {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # See one of the other client libraries for an example of sending deflate-compressed data. \## Dynamic Points # Post time-series data that can be graphed on Datadog's dashboards. See one of the other client libraries for an example of sending deflate-compressed data. ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v1/series" \ -H "Accept: application/json" \ -H "Content-Type: text/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -d @- << EOF { "series": [ { "host": "test.example.com", "metric": "system.load.1", "points": [ [ 1636629071, 0.7 ] ], "tags": [ "environment:test" ], "type": "gauge" } ] } EOF \## Dynamic Points # Post time-series data that can be graphed on Datadog's dashboards. \# Template variables export NOW="$(date +%s)" \# Curl command curl -X POST "https://api.datadoghq.com/api/v1/series" \ -H "Accept: application/json" \ -H "Content-Type: text/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -d @- << EOF { "series": [ { "metric": "system.load.1", "points": [[${NOW}, 1234.5]] } ] } EOF ##### ```go // Submit deflate metrics returns "Payload accepted" 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() { body := datadogV1.MetricsPayload{ Series: []datadogV1.Series{ { Metric: "system.load.1", Type: datadog.PtrString("gauge"), Points: [][]*float64{ { datadog.PtrFloat64(float64(time.Now().Unix())), datadog.PtrFloat64(1.1), }, }, Tags: []string{ "test:ExampleMetric", }, }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewMetricsApi(apiClient) resp, r, err := api.SubmitMetrics(ctx, body, *datadogV1.NewSubmitMetricsOptionalParameters().WithContentEncoding(datadogV1.METRICCONTENTENCODING_DEFLATE)) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.SubmitMetrics`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `MetricsApi.SubmitMetrics`:\n%s\n", responseContent) } ``` ##### ```go // Submit metrics returns "Payload accepted" 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() { body := datadogV1.MetricsPayload{ Series: []datadogV1.Series{ { Metric: "system.load.1", Type: datadog.PtrString("gauge"), Points: [][]*float64{ { datadog.PtrFloat64(float64(time.Now().Unix())), datadog.PtrFloat64(1.1), }, }, Tags: []string{ "test:ExampleMetric", }, }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewMetricsApi(apiClient) resp, r, err := api.SubmitMetrics(ctx, body, *datadogV1.NewSubmitMetricsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.SubmitMetrics`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `MetricsApi.SubmitMetrics`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" go run "main.go" ##### ```java // Submit deflate metrics returns "Payload accepted" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.MetricsApi; import com.datadog.api.client.v1.api.MetricsApi.SubmitMetricsOptionalParameters; import com.datadog.api.client.v1.model.IntakePayloadAccepted; import com.datadog.api.client.v1.model.MetricContentEncoding; import com.datadog.api.client.v1.model.MetricsPayload; import com.datadog.api.client.v1.model.Series; import java.time.OffsetDateTime; import java.util.Arrays; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); MetricsApi apiInstance = new MetricsApi(defaultClient); MetricsPayload body = new MetricsPayload() .series( Collections.singletonList( new Series() .metric("system.load.1") .type("gauge") .points( Collections.singletonList( Arrays.asList( Long.valueOf(OffsetDateTime.now().toInstant().getEpochSecond()) .doubleValue(), 1.1))) .tags(Collections.singletonList("test:ExampleMetric")))); try { IntakePayloadAccepted result = apiInstance.submitMetrics( body, new SubmitMetricsOptionalParameters().contentEncoding(MetricContentEncoding.DEFLATE)); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MetricsApi#submitMetrics"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ##### ```java // Submit metrics returns "Payload accepted" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.MetricsApi; import com.datadog.api.client.v1.model.IntakePayloadAccepted; import com.datadog.api.client.v1.model.MetricsPayload; import com.datadog.api.client.v1.model.Series; import java.time.OffsetDateTime; import java.util.Arrays; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); MetricsApi apiInstance = new MetricsApi(defaultClient); MetricsPayload body = new MetricsPayload() .series( Collections.singletonList( new Series() .metric("system.load.1") .type("gauge") .points( Collections.singletonList( Arrays.asList( Long.valueOf(OffsetDateTime.now().toInstant().getEpochSecond()) .doubleValue(), 1.1))) .tags(Collections.singletonList("test:ExampleMetric")))); try { IntakePayloadAccepted result = apiInstance.submitMetrics(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MetricsApi#submitMetrics"); 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://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" java "Example.java" ##### ```python from datadog import initialize, api import time options = { 'api_key': '' ## EU costumers need to define 'api_host' as below #'api_host': 'https://api.datadoghq.eu/' } initialize(**options) now = time.time() future_10s = now + 10 # Submit a single point with a timestamp of `now` api.Metric.send(metric='page.views', points=1000) # Submit a point with a timestamp (must be current) api.Metric.send(metric='my.pair', points=(now, 15)) # Submit multiple points. api.Metric.send( metric='my.series', points=[ (now, 15), (future_10s, 16) ] ) # Submit a point with a host and tags. api.Metric.send( metric='my.series', points=100, host="myhost.example.com", tags=["version:1"] ) # Submit multiple metrics api.Metric.send([{ 'metric': 'my.series', 'points': 15 }, { 'metric': 'my1.series', 'points': 16 }]) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python-legacy) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" python "example.py" ##### ```python """ Submit deflate metrics returns "Payload accepted" response """ from datetime import datetime from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.metrics_api import MetricsApi from datadog_api_client.v1.model.metric_content_encoding import MetricContentEncoding from datadog_api_client.v1.model.metrics_payload import MetricsPayload from datadog_api_client.v1.model.point import Point from datadog_api_client.v1.model.series import Series body = MetricsPayload( series=[ Series( metric="system.load.1", type="gauge", points=[ Point( [ datetime.now().timestamp(), 1.1, ] ), ], tags=[ "test:ExampleMetric", ], ), ], ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = MetricsApi(api_client) response = api_instance.submit_metrics(content_encoding=MetricContentEncoding.DEFLATE, body=body) print(response) ``` ##### ```python """ Submit metrics returns "Payload accepted" response """ from datetime import datetime from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.metrics_api import MetricsApi from datadog_api_client.v1.model.metrics_payload import MetricsPayload from datadog_api_client.v1.model.point import Point from datadog_api_client.v1.model.series import Series body = MetricsPayload( series=[ Series( metric="system.load.1", type="gauge", points=[ Point( [ datetime.now().timestamp(), 1.1, ] ), ], tags=[ "test:ExampleMetric", ], ), ], ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = MetricsApi(api_client) response = api_instance.submit_metrics(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" python3 "example.py" ##### ```ruby require 'rubygems' require 'dogapi' api_key = '' dog = Dogapi::Client.new(api_key) # Submit one metric value. dog.emit_point('some.metric.name', 50.0, :host => "my_host.example.com") # Submit multiple metric values points = [ [Time.now, 0], [Time.now + 10, 10.0], [Time.now + 20, 20.0] ] dog.emit_points('some.metric.name', points, :tags => ["version:1"]) # Emit differents metrics in a single request to be more efficient dog.batch_metrics do dog.emit_point('test.api.test_metric',10) dog.emit_point('test.api.this_other_metric', 1) end ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" rb "example.rb" ##### ```ruby # Submit deflate metrics returns "Payload accepted" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::MetricsAPI.new body = DatadogAPIClient::V1::MetricsPayload.new({ series: [ DatadogAPIClient::V1::Series.new({ metric: "system.load.1", type: "gauge", points: [ [ Time.now.to_f, 1.1, ], ], tags: [ "test:ExampleMetric", ], }), ], }) opts = { content_encoding: MetricContentEncoding::DEFLATE, } p api_instance.submit_metrics(body, opts) ``` ##### ```ruby # Submit metrics returns "Payload accepted" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::MetricsAPI.new body = DatadogAPIClient::V1::MetricsPayload.new({ series: [ DatadogAPIClient::V1::Series.new({ metric: "system.load.1", type: "gauge", points: [ [ Time.now.to_f, 1.1, ], ], tags: [ "test:ExampleMetric", ], }), ], }) p api_instance.submit_metrics(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" rb "example.rb" ##### ```rust // Submit deflate metrics returns "Payload accepted" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_metrics::MetricsAPI; use datadog_api_client::datadogV1::api_metrics::SubmitMetricsOptionalParams; use datadog_api_client::datadogV1::model::MetricContentEncoding; use datadog_api_client::datadogV1::model::MetricsPayload; use datadog_api_client::datadogV1::model::Series; #[tokio::main] async fn main() { let body = MetricsPayload::new(vec![Series::new( "system.load.1".to_string(), vec![vec![Some(1636629071.0 as f64), Some(1.1 as f64)]], ) .tags(vec!["test:ExampleMetric".to_string()]) .type_("gauge".to_string())]); let configuration = datadog::Configuration::new(); let api = MetricsAPI::with_config(configuration); let resp = api .submit_metrics( body, SubmitMetricsOptionalParams::default().content_encoding(MetricContentEncoding::DEFLATE), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` ##### ```rust // Submit metrics returns "Payload accepted" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_metrics::MetricsAPI; use datadog_api_client::datadogV1::api_metrics::SubmitMetricsOptionalParams; use datadog_api_client::datadogV1::model::MetricsPayload; use datadog_api_client::datadogV1::model::Series; #[tokio::main] async fn main() { let body = MetricsPayload::new(vec![Series::new( "system.load.1".to_string(), vec![vec![Some(1636629071.0 as f64), Some(1.1 as f64)]], ) .tags(vec!["test:ExampleMetric".to_string()]) .type_("gauge".to_string())]); let configuration = datadog::Configuration::new(); let api = MetricsAPI::with_config(configuration); let resp = api .submit_metrics(body, SubmitMetricsOptionalParams::default()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" cargo run ##### ```typescript /** * Submit deflate metrics returns "Payload accepted" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.MetricsApi(configuration); const params: v1.MetricsApiSubmitMetricsRequest = { body: { series: [ { metric: "system.load.1", type: "gauge", points: [[Math.round(new Date().getTime() / 1000), 1.1]], tags: ["test:ExampleMetric"], }, ], }, contentEncoding: "deflate", }; apiInstance .submitMetrics(params) .then((data: v1.IntakePayloadAccepted) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` ##### ```typescript /** * Submit metrics returns "Payload accepted" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.MetricsApi(configuration); const params: v1.MetricsApiSubmitMetricsRequest = { body: { series: [ { metric: "system.load.1", type: "gauge", points: [[Math.round(new Date().getTime() / 1000), 1.1]], tags: ["test:ExampleMetric"], }, ], }, }; apiInstance .submitMetrics(params) .then((data: v1.IntakePayloadAccepted) => { 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://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" tsc "example.ts" {% /tab %}