GitLab Usage data API

openapi: 3.2.0
info:
  title: GitLab REST Usage data 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: Usage data
  description: 'Use this API to track internal events and to retrieve the

    Service Ping payload that

    GitLab collects, including its non-SQL metrics and the queries behind it.'
  x-displayName: Usage data
  externalDocs:
    url: https://docs.gitlab.com/api/usage_data/
paths:
  /api/v4/usage_data/queries:
    get:
      operationId: getApiV4UsageDataQueries
      summary: List all Service Ping SQL queries
      description: Lists all raw SQL queries used to compute Service Ping. Administrators only.
      tags:
      - Usage data
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v4/usage_data/non_sql_metrics:
    get:
      operationId: getApiV4UsageDataNonSqlMetrics
      summary: List all non-SQL metrics
      description: Lists all non-SQL metrics data used in the Service ping. Administrators only.
      tags:
      - Usage data
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v4/usage_data/increment_counter:
    post:
      operationId: postApiV4UsageDataIncrementCounter
      summary: Track usage data event
      description: This feature was introduced in GitLab 13.4.
      tags:
      - Usage data
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4UsageDataIncrementCounterRequest'
  /api/v4/usage_data/increment_unique_users:
    post:
      operationId: postApiV4UsageDataIncrementUniqueUsers
      summary: Track usage data event for the current user
      description: Tracks a unique-user event for the current user in Service Ping.
      tags:
      - Usage data
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4UsageDataIncrementUniqueUsersRequest'
  /api/v4/usage_data/track_events:
    post:
      operationId: postApiV4UsageDataTrackEvents
      summary: Track multiple internal GitLab events
      description: Tracks one or more GitLab internal events in a single request. Each event increments Service Ping counters in Redis and is optionally sent to Snowplow. This feature was introduced in GitLab 17.3.
      tags:
      - Usage data
      responses:
        '200':
          description: OK
        '400':
          description: Validation error
        '401':
          description: Unauthorized
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4UsageDataTrackEventsRequest'
  /api/v4/usage_data/service_ping:
    get:
      operationId: getApiV4UsageDataServicePing
      summary: Retrieve Service Ping payload
      description: Retrieves the Service Ping payload from the application cache as JSON. If no cached payload is available, returns an empty response. Requires a personal access token with the `read_service_ping` scope. Introduced in GitLab 16.9.
      tags:
      - Usage data
      responses:
        '200':
          description: OK
        '401':
          description: 401 Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
  /api/v4/usage_data/track_event:
    post:
      operationId: postApiV4UsageDataTrackEvent
      summary: Track an internal GitLab event
      description: Tracks a GitLab internal event. This action increments Service Ping counters in Redis and is optionally sent to Snowplow. Introduced in GitLab 16.2.
      tags:
      - Usage data
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4UsageDataTrackEventRequest'
components:
  schemas:
    postApiV4UsageDataTrackEventRequest:
      type: object
      properties:
        event:
          type:
          - string
          - 'null'
          description: Name of the event to track.
          example: i_quickactions_page
        namespace_id:
          type:
          - integer
          - 'null'
          description: ID of the namespace associated with the event.
          example: 1234
        project_id:
          type:
          - integer
          - 'null'
          description: ID of the project. Mutually exclusive with `project_path`.
          example: 1234
        project_path:
          type:
          - string
          - 'null'
          description: Path of the project. Used to find `project_id` when it is not provided. Mutually exclusive with `project_id`.
          example: namespace/project
        additional_properties:
          type:
          - object
          - 'null'
          description: Additional properties to be tracked.
          example:
            label: login_button
            value: 1
        send_to_snowplow:
          type:
          - boolean
          - 'null'
          description: If `true`, sends the tracked event to Snowplow.
          example: true
      required:
      - event
    postApiV4UsageDataIncrementUniqueUsersRequest:
      type: object
      properties:
        event:
          type:
          - string
          - 'null'
          description: Event name that should be tracked.
          example: i_quickactions_page
      required:
      - event
    postApiV4UsageDataTrackEventsRequest:
      type: object
      properties:
        events:
          type:
          - array
          - 'null'
          items:
            type: object
          description: Array of internal events to track. Maximum of 50 events.
      required:
      - events
    postApiV4UsageDataIncrementCounterRequest:
      type: object
      properties:
        event:
          type:
          - string
          - 'null'
          description: Event name that should be tracked.
          example: i_quickactions_page
      required:
      - event
  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