--- title: Send an incident event description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > DORA Metrics --- # Send an incident event{% #send-an-incident-event %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------ | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/dora/failure | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/dora/failure | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/dora/failure | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/dora/failure | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/dora/failure | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/dora/failure | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/dora/failure | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/dora/failure | ### Overview Use this API endpoint to provide incident data for DORA Metrics. Note that change failure rate and failed deployment recovery time are computed from change failures detected on deployments, not from incident events sent through this endpoint. Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents, including their severity and frequency. ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | -------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | The JSON:API data. | | data | attributes [*required*] | object | Attributes to create a DORA incident event. | | attributes | custom_tags | [string] | A list of user-defined tags. The tags must follow the `key:value` pattern. Up to 100 may be added per event. | | attributes | env | string | Environment name that was impacted by the incident. | | attributes | finished_at | int64 | Unix timestamp when the incident finished. It must be in nanoseconds, milliseconds, or seconds. | | attributes | git | object | Git info for DORA Metrics events. | | git | commit_sha [*required*] | string | Git Commit SHA. | | git | repository_url [*required*] | string | Git Repository URL | | attributes | id | string | Incident ID. Must be 16-128 characters and contain only alphanumeric characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, -, _, ., :). | | attributes | name | string | Incident name. | | attributes | services | [string] | Service names impacted by the incident. If possible, use names registered in the Service Catalog. Required when the team field is not provided. | | attributes | severity | string | Incident severity. | | attributes | started_at [*required*] | int64 | Unix timestamp when the incident started. It must be in nanoseconds, milliseconds, or seconds. | | attributes | team | string | Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided. | | attributes | version | string | Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking.md). | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "custom_tags": [ "language:java", "department:engineering" ], "env": "staging", "finished_at": 1693491984000000000, "git": { "commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository" }, "id": "string", "name": "Webserver is down failing all requests.", "services": [ "shopist" ], "severity": "High", "started_at": 1693491974000000000, "team": "backend", "version": "v1.12.07" } } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Response after receiving a DORA incident event. | Parent field | Field | Type | Description | | ------------ | ---------------------- | ------ | --------------------------------------------------------------------------- | | | data [*required*] | object | Response after receiving a DORA incident event. | | data | id [*required*] | string | The ID of the received DORA incident event. | | data | type | enum | JSON:API type for DORA incident events. Allowed enum values: `dora_failure` | {% /tab %} {% tab title="Example" %} ```json { "data": { "id": "4242fcdd31586083", "type": "dora_failure" } } ``` {% /tab %} {% /tab %} {% tab title="202" %} OK - but delayed due to incident {% tab title="Model" %} Response after receiving a DORA incident event. | Parent field | Field | Type | Description | | ------------ | ---------------------- | ------ | --------------------------------------------------------------------------- | | | data [*required*] | object | Response after receiving a DORA incident event. | | data | id [*required*] | string | The ID of the received DORA incident event. | | data | type | enum | JSON:API type for DORA incident events. Allowed enum values: `dora_failure` | {% /tab %} {% tab title="Example" %} ```json { "data": { "id": "4242fcdd31586083", "type": "dora_failure" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Not Authorized {% 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/dora/failure" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -d @- << EOF { "data": { "attributes": { "custom_tags": [ "language:java", "department:engineering" ], "env": "staging", "finished_at": 1693491984000000000, "git": { "commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository" }, "name": "Webserver is down failing all requests.", "services": [ "test-service" ], "severity": "High", "started_at": 1693491974000000000, "team": "backend", "version": "v1.12.07" } } } EOF ##### ```python """ Send an incident event returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.dora_metrics_api import DORAMetricsApi from datadog_api_client.v2.model.dora_failure_request import DORAFailureRequest from datadog_api_client.v2.model.dora_failure_request_attributes import DORAFailureRequestAttributes from datadog_api_client.v2.model.dora_failure_request_data import DORAFailureRequestData from datadog_api_client.v2.model.dora_git_info import DORAGitInfo body = DORAFailureRequest( data=DORAFailureRequestData( attributes=DORAFailureRequestAttributes( custom_tags=[ "language:java", "department:engineering", ], env="staging", finished_at=1693491984000000000, git=DORAGitInfo( commit_sha="66adc9350f2cc9b250b69abddab733dd55e1a588", repository_url="https://github.com/organization/example-repository", ), name="Webserver is down failing all requests.", services=[ "shopist", ], severity="High", started_at=1693491974000000000, team="backend", version="v1.12.07", ), ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DORAMetricsApi(api_client) response = api_instance.create_dora_failure(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 # Send an incident event returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::DORAMetricsAPI.new body = DatadogAPIClient::V2::DORAFailureRequest.new({ data: DatadogAPIClient::V2::DORAFailureRequestData.new({ attributes: DatadogAPIClient::V2::DORAFailureRequestAttributes.new({ custom_tags: [ "language:java", "department:engineering", ], env: "staging", finished_at: 1693491984000000000, git: DatadogAPIClient::V2::DORAGitInfo.new({ commit_sha: "66adc9350f2cc9b250b69abddab733dd55e1a588", repository_url: "https://github.com/organization/example-repository", }), name: "Webserver is down failing all requests.", services: [ "shopist", ], severity: "High", started_at: 1693491974000000000, team: "backend", version: "v1.12.07", }), }), }) p api_instance.create_dora_failure(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" ##### ```go // Send an incident event returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { body := datadogV2.DORAFailureRequest{ Data: datadogV2.DORAFailureRequestData{ Attributes: datadogV2.DORAFailureRequestAttributes{ CustomTags: *datadog.NewNullableList(&[]string{ "language:java", "department:engineering", }), Env: datadog.PtrString("staging"), FinishedAt: datadog.PtrInt64(1693491984000000000), Git: &datadogV2.DORAGitInfo{ CommitSha: "66adc9350f2cc9b250b69abddab733dd55e1a588", RepositoryUrl: "https://github.com/organization/example-repository", }, Name: datadog.PtrString("Webserver is down failing all requests."), Services: []string{ "shopist", }, Severity: datadog.PtrString("High"), StartedAt: 1693491974000000000, Team: datadog.PtrString("backend"), Version: datadog.PtrString("v1.12.07"), }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewDORAMetricsApi(apiClient) resp, r, err := api.CreateDORAFailure(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DORAMetricsApi.CreateDORAFailure`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DORAMetricsApi.CreateDORAFailure`:\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 // Send an incident event returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.DoraMetricsApi; import com.datadog.api.client.v2.model.DORAFailureRequest; import com.datadog.api.client.v2.model.DORAFailureRequestAttributes; import com.datadog.api.client.v2.model.DORAFailureRequestData; import com.datadog.api.client.v2.model.DORAFailureResponse; import com.datadog.api.client.v2.model.DORAGitInfo; import java.util.Arrays; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DoraMetricsApi apiInstance = new DoraMetricsApi(defaultClient); DORAFailureRequest body = new DORAFailureRequest() .data( new DORAFailureRequestData() .attributes( new DORAFailureRequestAttributes() .customTags(Arrays.asList("language:java", "department:engineering")) .env("staging") .finishedAt(1693491984000000000L) .git( new DORAGitInfo() .commitSha("66adc9350f2cc9b250b69abddab733dd55e1a588") .repositoryUrl( "https://github.com/organization/example-repository")) .name("Webserver is down failing all requests.") .services(Collections.singletonList("shopist")) .severity("High") .startedAt(1693491974000000000L) .team("backend") .version("v1.12.07"))); try { DORAFailureResponse result = apiInstance.createDORAFailure(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DoraMetricsApi#createDORAFailure"); 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" ##### ```rust // Send an incident event returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_dora_metrics::DORAMetricsAPI; use datadog_api_client::datadogV2::model::DORAFailureRequest; use datadog_api_client::datadogV2::model::DORAFailureRequestAttributes; use datadog_api_client::datadogV2::model::DORAFailureRequestData; use datadog_api_client::datadogV2::model::DORAGitInfo; #[tokio::main] async fn main() { let body = DORAFailureRequest::new(DORAFailureRequestData::new( DORAFailureRequestAttributes::new(1693491974000000000) .custom_tags(Some(vec![ "language:java".to_string(), "department:engineering".to_string(), ])) .env("staging".to_string()) .finished_at(1693491984000000000) .git(DORAGitInfo::new( "66adc9350f2cc9b250b69abddab733dd55e1a588".to_string(), "https://github.com/organization/example-repository".to_string(), )) .name("Webserver is down failing all requests.".to_string()) .services(vec!["shopist".to_string()]) .severity("High".to_string()) .team("backend".to_string()) .version("v1.12.07".to_string()), )); let configuration = datadog::Configuration::new(); let api = DORAMetricsAPI::with_config(configuration); let resp = api.create_dora_failure(body).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 /** * Send an incident event returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.DORAMetricsApi(configuration); const params: v2.DORAMetricsApiCreateDORAFailureRequest = { body: { data: { attributes: { customTags: ["language:java", "department:engineering"], env: "staging", finishedAt: 1693491984000000000, git: { commitSha: "66adc9350f2cc9b250b69abddab733dd55e1a588", repositoryUrl: "https://github.com/organization/example-repository", }, name: "Webserver is down failing all requests.", services: ["shopist"], severity: "High", startedAt: 1693491974000000000, team: "backend", version: "v1.12.07", }, }, }, }; apiInstance .createDORAFailure(params) .then((data: v2.DORAFailureResponse) => { 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 %}