GitLab DORA metrics API

openapi: 3.2.0
info:
  title: GitLab REST DORA metrics API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: DORA metrics
  description: 'Use this API to retrieve DORA metrics for

    groups and projects. Additional metrics are available through the

    GraphQL API.


    These endpoints require the Reporter, Developer, Maintainer, or Owner role.'
  x-displayName: DORA metrics
  externalDocs:
    url: https://docs.gitlab.com/api/dora/metrics/
paths:
  /api/v4/projects/{id}/dora/metrics:
    get:
      operationId: getApiV4ProjectsIdDoraMetrics
      summary: Retrieve project-level DORA metrics
      description: Retrieves DORA metrics for a specified project.
      tags:
      - DORA metrics
      responses:
        '200':
          description: successful operation
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: metric
        required: true
        description: The DORA metric to fetch.
        schema:
          type: string
          enum:
          - deployment_frequency
          - lead_time_for_changes
          - time_to_restore_service
          - change_failure_rate
          minLength: 1
        in: query
      - name: start_date
        required: false
        description: Start date of the date range. Defaults to 3 months ago.
        schema:
          type:
          - string
          - 'null'
          format: date
        in: query
      - name: end_date
        required: false
        description: End date of the date range. Defaults to the current date.
        schema:
          type:
          - string
          - 'null'
          format: date
        in: query
      - name: interval
        required: false
        description: The bucketing interval.
        schema:
          type: string
          enum:
          - all
          - monthly
          - daily
          default: daily
        in: query
      - name: environment_tiers
        required: false
        description: The tiers of the environments.
        schema:
          type: array
          items:
            type: string
            enum:
            - production
            - staging
            - testing
            - development
            - other
          default:
          - production
        in: query
      x-gitlab-tier: ultimate
  /api/v4/groups/{id}/dora/metrics:
    get:
      operationId: getApiV4GroupsIdDoraMetrics
      summary: Retrieve group-level DORA metrics
      description: Retrieves DORA metrics for a specified group.
      tags:
      - DORA metrics
      responses:
        '200':
          description: successful operation
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
      - name: metric
        required: true
        description: The DORA metric to fetch.
        schema:
          type: string
          enum:
          - deployment_frequency
          - lead_time_for_changes
          - time_to_restore_service
          - change_failure_rate
          minLength: 1
        in: query
      - name: start_date
        required: false
        description: Start date of the date range. Defaults to 3 months ago.
        schema:
          type:
          - string
          - 'null'
          format: date
        in: query
      - name: end_date
        required: false
        description: End date of the date range. Defaults to the current date.
        schema:
          type:
          - string
          - 'null'
          format: date
        in: query
      - name: interval
        required: false
        description: The bucketing interval.
        schema:
          type: string
          enum:
          - all
          - monthly
          - daily
          default: daily
        in: query
      - name: environment_tiers
        required: false
        description: The tiers of the environments.
        schema:
          type: array
          items:
            type: string
            enum:
            - production
            - staging
            - testing
            - development
            - other
          default:
          - production
        in: query
      x-gitlab-tier: ultimate
components:
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header