dotCMS

dotCMS Usage API

Provides business intelligence metrics for dashboard usage

Documentation GitHub OpenAPI

Operations 1

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/usage/summary Get the usage dashboard summary · Get usage dashboard summary #

Ask an LLM

“How much content, how many sites and users does my dotCMS instance have?”

“Can I get a lighter or fuller usage summary by choosing a profile?”

Tell an agent

Show the usage dashboard summary.

Get the usage summary with the {profile} metric profile.

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/dotcms:dotcms-usage-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: dotCMS REST Usage API
  version: '3'
  description: Provides business intelligence metrics for dashboard usage
servers:
- url: /
  description: dotCMS Server
tags:
- name: Usage
  description: Provides business intelligence metrics for dashboard usage
paths:
  /api/v1/usage/summary:
    get:
      tags:
      - Usage
      summary: Get usage dashboard summary
      description: Retrieves key business metrics optimized for dashboard display including content, sites, users, and system metrics. Supports optional profile parameter (MINIMAL, STANDARD, FULL) to override the default metric collection profile.
      operationId: getSummary
      parameters:
      - name: profile
        in: query
        description: 'Metric collection profile to use. MINIMAL (default): Fast collection with 10-15 core metrics. STANDARD: Comprehensive collection with ~50 metrics. FULL: Complete collection with all available metrics. This allows administrators to view additional metrics beyond the default MINIMAL profile.'
        schema:
          type: string
          enum:
          - MINIMAL
          - STANDARD
          - FULL
          default: MINIMAL
      responses:
        '200':
          description: Dashboard summary retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityUsageSummaryView'
        '400':
          description: Invalid profile parameter
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
components:
  schemas:
    MessageEntity:
      type: object
      properties:
        message:
          type: string
    ResponseEntityUsageSummaryView:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorEntity'
        entity:
          $ref: '#/components/schemas/UsageSummary'
        messages:
          type: array
          items:
            $ref: '#/components/schemas/MessageEntity'
        i18nMessagesMap:
          type: object
          additionalProperties:
            type: string
        permissions:
          type: array
          items:
            type: string
        pagination:
          $ref: '#/components/schemas/Pagination'
    Pagination:
      type: object
      properties:
        currentPage:
          type: integer
          format: int32
        perPage:
          type: integer
          format: int32
        totalEntries:
          type: integer
          format: int64
    UsageSummary:
      type: object
      properties:
        metrics:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
        lastUpdated:
          type: string
          format: date-time
    ErrorEntity:
      type: object
      properties:
        errorCode:
          type: string
        message:
          type: string
        fieldName:
          type: string
x-provenance:
  method: harvested
  publisher: dotCMS
  source: https://demo.dotcms.com/api/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)