v1

latestOpenAPI 3.0.32026-07-172411.7 KB

summary

Query the benchmark key for a given DORA Metric

Returns a key corresponding to the benchmark calculated from the data points that match the filters. The metrics currently supported are below:

Metric Type	Description	Benchmark keys
df	Deployment frequency.	on-demand, week-month, month-6month, lt-6month
mltc	Median lead time for changes.	lt-1hour, lt-1week, week-6month, mt-6month
cfr	Change Failure Rate.	lt-15p, 15-25p, 25-30p, mt-30p
mttr	Mean Time to Recovery	lt-1hour, lt-1day, day-week, mt-6month

get/benchmark

Query parameters

type'df' | 'mltc' | 'cfr' | 'mttr' required

required. Specify the type of metric the benchmark should be calculated for

projectstring

optional. Specify the project/repo/component to which the metric benchmark should be retrieved

teamstring

optional. Specify the team to which the metric benchmark should be retrieved

fromstring date-time

Example:2020-01-01T00:00:00Z

optional. Date/time from when the results should be filtered. If not informed, it will assume 6 months from the current date/time Should be before the 'to' param, and should always be paired with the 'to' param. Time-span should be at least 6 months to get an accurate benchmark.

tostring date-time

Example:2020-01-31T23:59:59Z

optional. Date/time to when the results should be filtered. If not informed, it will assume the current date/time Should be before the current date/time and after the 'from' param, and should always be paired with the 'from' param.

Headers

x-correlation-idstring uuid

Unique identifer associated with the request

Response

Success

keystring required

month-6month would correspond to the text "Between once per month and once every 6 months" for example.

Example response

{
  "key": "month-6month"
}