--- title: DORA メトリクスのデプロイイベントを送信 description: この API エンドポイントで、DORA メトリクスに関連するデプロイメントデータを提供します。 これは以下のために必要です。 - デプロイメントの頻度 - 変更リードタイム - 変更失敗率 breadcrumbs: ドキュメント > API > DORA メトリクスのデプロイイベントを送信 --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # DORA メトリクスのデプロイイベントを送信 ## v2 (latest) | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------- | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/dora/deployment | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/dora/deployment | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/dora/deployment | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/dora/deployment | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/dora/deployment | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/dora/deployment | | uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/dora/deployment | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/dora/deployment | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/dora/deployment | ### Overview この API エンドポイントで、DORA メトリクスに関連するデプロイメントデータを提供します。 これは以下のために必要です。 - デプロイメントの頻度 - 変更リードタイム - 変更失敗率 ### Request #### Body Data (required) {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | ------------ | --------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | DORA デプロイメントイベントの作成リクエスト。 | | data | attributes [*required*] | object | Attributes to create a DORA deployment 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 to where the service was deployed. | | attributes | finished_at [*required*] | int64 | Unix timestamp when the deployment 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 | Deployment ID. Must be 16-128 characters and contain only alphanumeric characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, -, _, ., :). | | attributes | service [*required*] | string | Service name. | | attributes | started_at [*required*] | int64 | Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds. | | attributes | team | string | Name of the team owning the deployed service. If not provided, this is automatically populated with the team associated with the service in the Service Catalog. | | attributes | version | string | Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking.md). | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "finished_at": 1693491984000000000, "git": { "commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository" }, "service": "shopist", "started_at": 1693491974000000000, "version": "v1.12.07" } } } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response after receiving a DORA deployment event. | Parent field | Field | Type | Description | | ------------ | ----------------- | ------ | ------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | The JSON:API data. | | data | id [*required*] | string | The ID of the received DORA deployment event. | | data | type | enum | JSON:API type for DORA deployment events. Allowed enum values: `dora_deployment`. Default: `dora_deployment`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "id": "4242fcdd31586083", "type": "dora_deployment" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="202" %} OK - but delayed due to incident {% tabs %} {% tab label="Model" %} Response after receiving a DORA deployment event. | Parent field | Field | Type | Description | | ------------ | ----------------- | ------ | ------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | The JSON:API data. | | data | id [*required*] | string | The ID of the received DORA deployment event. | | data | type | enum | JSON:API type for DORA deployment events. Allowed enum values: `dora_deployment`. Default: `dora_deployment`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "id": "4242fcdd31586083", "type": "dora_deployment" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="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 label="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 %} {% /tabs %} {% /tab %} {% tab label="403" %} Not Authorized {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # 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 export DD_API_KEY="" curl -X POST "https://api.${DD_SITE}/api/v2/dora/deployment" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -d @- << EOF { "data": { "attributes": { "finished_at": 1693491984000000000, "git": { "commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository" }, "service": "shopist", "started_at": 1693491974000000000, "version": "v1.12.07" } } } EOF ``` {% /tab %} {% /tabs %}