Commit 4a510dfb authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs-nfriend-explain-dora4-api-value' into 'master'

Add explanation of `value` field in DORA 4 API response

See merge request gitlab-org/gitlab!58785
parents f82bb656 554e68f8
......@@ -88,3 +88,14 @@ Example response:
{ "2021-03-08": 4, "date": "2021-03-08", "value": 4 }
]
```
## The `value` field
For both the project and group-level endpoints above, the `value` field in the
API response has a different meaning depending on the provided `metric` query
parameter:
| `metric` query parameter | Description of `value` in response |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `deployment_frequency` | The number of successful deployments during the time period. |
| `lead_time_for_changes` | The median number of seconds between the merge of the merge request (MR) and the deployment of the MR's commits for all MRs deployed during the time period. |
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment