GitLab Analytics API

openapi: 3.2.0
info:
  title: GitLab REST Analytics 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: Analytics
  description: 'Use this API to retrieve analytics about a group''s activity, a project''s deployment frequency, and

    product analytics data. For more information about the group metrics, see

    group activity analytics.'
  x-displayName: Analytics
  externalDocs:
    url: https://docs.gitlab.com/api/group_activity_analytics/
paths:
  /api/v4/projects/{id}/analytics/deployment_frequency:
    get:
      operationId: getApiV4ProjectsIdAnalyticsDeploymentFrequency
      summary: List deployment frequencies for the project
      description: Retrieves deployment frequency analytics data for a specific project.
      tags:
      - Analytics
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesAnalyticsDeploymentFrequency'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: environment
        required: true
        description: Name of the environment to filter by.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: from
        required: true
        description: Datetime to start from, inclusive.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
      - name: to
        required: false
        description: Datetime to end at, exclusive. If omitted, defaults to the current time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
      - name: interval
        required: false
        description: Interval to roll up data by. If omitted, defaults to `all`.
        schema:
          type:
          - string
          - 'null'
          enum:
          - all
          - monthly
          - daily
          - null
        in: query
      x-gitlab-tier: ultimate
  /api/v4/analytics/group_activity/issues_count:
    get:
      operationId: getApiV4AnalyticsGroupActivityIssuesCount
      summary: Retrieve count of recently created issues for a group
      description: Retrieves the count of recently created issues for a specified group.
      tags:
      - Analytics
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAnalyticsGroupActivityIssuesCount'
        '400':
          description: Bad Request
      parameters:
      - name: group_path
        required: true
        description: Group path.
        schema:
          type:
          - string
          - 'null'
        in: query
      x-gitlab-tier: premium
  /api/v4/analytics/group_activity/merge_requests_count:
    get:
      operationId: getApiV4AnalyticsGroupActivityMergeRequestsCount
      summary: Retrieve count of recently created merge requests for a group
      description: Retrieves the count of recently created merge requests for a specified group.
      tags:
      - Analytics
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAnalyticsGroupActivityMergeRequestsCount'
        '400':
          description: Bad Request
      parameters:
      - name: group_path
        required: true
        description: Group path.
        schema:
          type:
          - string
          - 'null'
        in: query
      x-gitlab-tier: premium
  /api/v4/analytics/group_activity/new_members_count:
    get:
      operationId: getApiV4AnalyticsGroupActivityNewMembersCount
      summary: Retrieve count of members recently added to a group
      description: Retrieves the count of members recently added to a specified group.
      tags:
      - Analytics
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAnalyticsGroupActivityNewMembersCount'
        '400':
          description: Bad Request
      parameters:
      - name: group_path
        required: true
        description: Group path.
        schema:
          type:
          - string
          - 'null'
        in: query
      x-gitlab-tier: premium
components:
  schemas:
    APIEntitiesAnalyticsGroupActivityNewMembersCount:
      type: object
      properties:
        new_members_count:
          type: integer
          description: Number of new members. Limited to 1000
          example: 3
    APIEntitiesAnalyticsGroupActivityMergeRequestsCount:
      type: object
      properties:
        merge_requests_count:
          type: integer
          description: Number of merge requests. Limited to 1000
          example: 3
    APIEntitiesAnalyticsGroupActivityIssuesCount:
      type: object
      properties:
        issues_count:
          type: integer
          description: Number of issues. Limited to 1000
          example: 3
    APIEntitiesAnalyticsDeploymentFrequency:
      type: object
      properties:
        value:
          type: string
        from:
          type: string
        to:
          type: string
  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