GitLab CI/CD

GitLab CI/CD usage_data API

Operations about usage_data

GitHub OpenAPI

Operations 7

POST /api/v4/usage_data/increment_counter Track usage data event #
POST /api/v4/usage_data/increment_unique_users #
POST /api/v4/usage_data/track_events Track multiple gitlab internal events #
GET /api/v4/usage_data/service_ping Get the latest ServicePing payload #
POST /api/v4/usage_data/track_event Track gitlab internal events #
GET /api/v4/usage_data/non_sql_metrics Get Non SQL usage ping metrics #
GET /api/v4/usage_data/queries Get raw SQL queries for usage data SQL metrics #

Documentation

📖
Documentation
https://docs.gitlab.com/api/
📖
APIReference
https://docs.gitlab.com/api/api_resources/
📖
Authentication
https://docs.gitlab.com/api/rest/authentication/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gitlab-ci/refs/heads/main/openapi/gitlab-ci-usage-data-api-openapi.yml

Other Resources

🔗
OpenAPISource
https://docs.gitlab.com/api/openapi/openapi_v2.yaml
🔗
InteractiveDocs
https://docs.gitlab.com/api/openapi/openapi_interactive/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gitlab-ci-usage-data-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gitlab-ci-usage-data-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitLab access_requests Usage Data API
  version: v4
  description: Operations related to access requests
servers:
- url: https://gitlab.com
tags:
- name: usage_data
  description: Operations about usage_data
paths:
  /api/v4/usage_data/increment_counter:
    post:
      summary: Track usage data event
      description: This feature was introduced in GitLab 13.4.
      responses:
        '200':
          description: Track usage data event
        '401':
          description: Unauthorized
        '404':
          description: Not found
      tags:
      - usage_data
      operationId: postApiV4UsageDataIncrementCounter
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4UsageDataIncrementCounter'
        required: true
  /api/v4/usage_data/increment_unique_users:
    post:
      description: Track usage data event for the current user
      responses:
        '200':
          description: Track usage data event for the current user
        '401':
          description: Unauthorized
        '404':
          description: Not found
      tags:
      - usage_data
      operationId: postApiV4UsageDataIncrementUniqueUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4UsageDataIncrementUniqueUsers'
        required: true
  /api/v4/usage_data/track_events:
    post:
      summary: Track multiple gitlab internal events
      description: This feature was introduced in GitLab 17.3.
      responses:
        '200':
          description: Track multiple gitlab internal events
        '400':
          description: Validation error
        '401':
          description: Unauthorized
      tags:
      - usage_data
      operationId: postApiV4UsageDataTrackEvents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4UsageDataTrackEvents'
        required: true
  /api/v4/usage_data/service_ping:
    get:
      summary: Get the latest ServicePing payload
      description: Introduces in Gitlab 16.9. Requires personal access token with read_service_ping scope.
      responses:
        '200':
          description: Get the latest ServicePing payload
        '401':
          description: 401 Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      tags:
      - usage_data
      operationId: getApiV4UsageDataServicePing
  /api/v4/usage_data/track_event:
    post:
      summary: Track gitlab internal events
      description: This feature was introduced in GitLab 16.2.
      responses:
        '200':
          description: Track gitlab internal events
        '401':
          description: Unauthorized
        '404':
          description: Not found
      tags:
      - usage_data
      operationId: postApiV4UsageDataTrackEvent
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4UsageDataTrackEvent'
        required: true
  /api/v4/usage_data/non_sql_metrics:
    get:
      summary: Get Non SQL usage ping metrics
      description: This feature was introduced in GitLab 13.11.
      responses:
        '200':
          description: Get Non SQL usage ping metrics
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      tags:
      - usage_data
      operationId: getApiV4UsageDataNonSqlMetrics
  /api/v4/usage_data/queries:
    get:
      summary: Get raw SQL queries for usage data SQL metrics
      description: This feature was introduced in GitLab 13.11.
      responses:
        '200':
          description: Get raw SQL queries for usage data SQL metrics
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      tags:
      - usage_data
      operationId: getApiV4UsageDataQueries
components:
  schemas:
    postApiV4UsageDataIncrementCounter:
      type: object
      properties:
        event:
          type: string
          description: The event name that should be tracked
          example: i_quickactions_page
      required:
      - event
      description: Track usage data event
    postApiV4UsageDataTrackEvents:
      type: object
      properties:
        events:
          type: array
          description: An array of internal events. Maximum 50 events allowed.
          items:
            type: object
            properties:
              event:
                type: string
                description: The event name that should be tracked
                example: i_quickactions_page
              namespace_id:
                type: integer
                format: int32
                description: Namespace ID
                example: 1234
              project_id:
                type: integer
                format: int32
                description: Project ID
                example: 1234
              project_path:
                type: string
                description: Project path (used to resolve project_id if not provided)
                example: namespace/project
              additional_properties:
                type: object
                description: Additional properties to be tracked
                example:
                  label: login_button
                  value: 1
              send_to_snowplow:
                type: boolean
                description: Send the tracked event to Snowplow
                default: false
                example: true
            required:
            - event
      required:
      - events
      description: Track multiple gitlab internal events
    postApiV4UsageDataIncrementUniqueUsers:
      type: object
      properties:
        event:
          type: string
          description: The event name that should be tracked
          example: i_quickactions_page
      required:
      - event
      description: Track usage data event for the current user
    postApiV4UsageDataTrackEvent:
      type: object
      properties:
        event:
          type: string
          description: The event name that should be tracked
          example: i_quickactions_page
        namespace_id:
          type: integer
          format: int32
          description: Namespace ID
          example: 1234
        project_id:
          type: integer
          format: int32
          description: Project ID
          example: 1234
        project_path:
          type: string
          description: Project path (used to resolve project_id if not provided)
          example: namespace/project
        additional_properties:
          type: object
          description: Additional properties to be tracked
          example:
            label: login_button
            value: 1
        send_to_snowplow:
          type: boolean
          description: Send the tracked event to Snowplow
          default: false
          example: true
      required:
      - event
      description: Track gitlab internal events
  securitySchemes:
    access_token_header:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header
    access_token_query:
      type: apiKey
      name: private_token
      in: query