DORA

This contains APIs specific to the DORA reports

Retrieve lead time data

This endpoint is paginated and retrieves lead time data.

Securityx-api-key
Request
Request Body schema: application/json
required
object
ou_ids
Array of strings
across
string
Responses
200

OK response.

post/v1/dora/lead-time
Request samples
application/json
{
  • "filter": {
    },
  • "ou_ids": [
    ],
  • "across": "velocity"
}
Response samples
application/json
{
  • "records": [
    ],
  • "count": 1,
  • "_metadata": {
    }
}

Retrieve deployment frequency data

This endpoint is paginated and retrieves deployment frequency data.

Securityx-api-key
Request
Request Body schema: application/json
required
object
ou_ids
Array of strings
Responses
200

OK response.

post/v1/dora/deployment_frequency
Request samples
application/json
{
  • "filter": {
    },
  • "ou_ids": [
    ]
}
Response samples
application/json
{
  • "time_series": {
    },
  • "stats": {
    }
}

Retrieve change failure rate data

This endpoint is paginated and retrieves change failure rate data.

Securityx-api-key
Request
Request Body schema: application/json
required
object
ou_ids
Array of strings
Responses
200

OK response.

post/v1/dora/change_failure_rate
Request samples
application/json
{
  • "filter": {
    },
  • "ou_ids": [
    ]
}
Response samples
application/json
{
  • "time_series": {
    },
  • "stats": {
    }
}

Retrieve Mean Time to Restore (MTTR) data

This endpoint retrieves Mean Time to Restore (MTTR) data for DORA metrics.

Securityx-api-key
Request
Request Body schema: application/json
required
object
ou_ids
Array of strings

Array of organizational unit IDs

across
string

Dimension to calculate across

widget_id
string

Unique identifier for the widget

Responses
200

OK response.

post/v1/dora/mean-time
Request samples
application/json
{
  • "filter": {
    },
  • "ou_ids": [
    ],
  • "across": "velocity",
  • "widget_id": "<WIDGET_ID>"
}
Response samples
application/json
{
  • "mean_time": 4.5,
  • "unit": "hours",
  • "band": "MEDIUM",
  • "total_incidents": 20
}