v1

latestOpenAPI 3.0.32026-07-172411.7 KB
data-points

Query data points for a given DORA Metric

Returns the data points for the requested metric according to the informed filters. The below are the metrics currently supported:

Metric TypeDescription
df_averageDeployment frequency (average), aggregated according to the aggregation parameter
df_countAmount of Deployments, aggregated according to the aggregation parameter
mltcMedian Lead Time for Changes, aggregated according to the aggregation parameter
cfrChange Failure Rate, aggregated according to the aggregation parameter
mttrMean Time to Recovery, aggregated according to the aggregation parameter
get/metric

Query parameters

type'df_average' | 'df_count' | 'mltc' | 'cfr' | 'mttr' required

required. Specify the type of metric the data points should be retrieved to

aggregation'weekly' | 'monthly' | 'quarterly'

optional. Specify how the data points should be aggregated. If not informed, it will default to weekly

projectstring

optional. Specify the project/repo/component to which the data points should be retrieved

teamstring

optional. Specify the team to which the data points 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.

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

aggregationstring required

Example response

{
  "aggregation": "weekly",
  "dataPoints": [
    {
      "value": 103.5
    }
  ]
}
All 2 operations