dotCMS

dotCMS Content Analytics API

Proxy endpoints that forward analytics requests to the dot-ca-event-manager service.

Documentation GitHub OpenAPI

Operations 3

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/analytics/content/siteauth/generate/{siteId} Generate a site key for analytics events · Generate Site Auth #

Ask an LLM

“How do I get the site key my front-end JavaScript needs to send custom analytics events?”

“Can I generate a Content Analytics site auth key per site?”

Tell an agent

Generate a Content Analytics site key for site {siteId}.

Create the site auth key for {siteId} so the client JS can post events.

POST /api/v1/analytics/content/event Send a custom analytics event · Proxy analytics event ingest with site auth validation #

Ask an LLM

“How do I record a custom Content Analytics event from my site?”

“What happens if the site_auth in my event payload is invalid?”

Tell an agent

Send this custom analytics event with its site_auth key.

Ingest a Content Analytics event for the active site.

GET /api/v1/analytics/{path} Query Content Analytics data · Proxy any analytics GET request #

Ask an LLM

“Can I query Content Analytics reports through dotCMS for a site I can read?”

“Which analytics GET route forwards my query parameters upstream?”

Tell an agent

Query Content Analytics at path {path}.

Fetch analytics data from {path} for my current site.

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-content-analytics-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

openapi: 3.2.0
info:
  title: dotCMS REST Content Analytics API
  version: '3'
  description: Proxy endpoints that forward analytics requests to the dot-ca-event-manager service.
servers:
- url: /
  description: dotCMS Server
tags:
- name: Content Analytics
  description: Proxy endpoints that forward analytics requests to the dot-ca-event-manager service.
paths:
  /api/v1/analytics/content/siteauth/generate/{siteId}:
    get:
      tags:
      - Content Analytics
      summary: Generate Site Auth
      description: Generates and returns a Site Key that must be used by the client-side JS code to send custom Content Analytics Events
      operationId: generateSiteAuth
      parameters:
      - name: siteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The Site key was generated and returned successfully
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Site ID in path is not found or incorrect path
        '405':
          description: Method Not Allowed
        '500':
          description: Internal Server Error
  /api/v1/analytics/content/event:
    post:
      tags:
      - Content Analytics
      summary: Proxy analytics event ingest with site auth validation
      description: Validates the site_auth field in the JSON body via SiteAuthValidator, resolves the active site, injects site_id into context, and asynchronously forwards the body to {DOT_ANALYTICS_BASE_URL}/v1/event/ingest. The dotCMS-side path is a fixed match; the upstream sub-path is not caller-controllable.
      operationId: proxyAnalyticsEventRequest
      requestBody:
        description: JSON request body with a `context.site_auth` value and event payload
        content:
          application/json:
            schema:
              type: string
        required: true
      responses:
        '200':
          description: Successful upstream response
          content:
            application/json:
              schema:
                type: object
                description: dotCMS response envelope containing the upstream analytics data
        '400':
          description: Invalid siteAuth or upstream returned an error
          content:
            application/json: {}
        '500':
          description: Internal server error or upstream unreachable
          content:
            application/json: {}
  /api/v1/analytics/{path}:
    get:
      tags:
      - Content Analytics
      summary: Proxy any analytics GET request
      description: 'Forwards any authenticated GET request to /v1/analytics/** to the dot-ca-event-manager service at /v1/**, preserving all query parameters. Requests are site-permission gated: the caller must have READ on the site resolved from ?siteId=, ?host_id=, or the session fallback.'
      operationId: proxyAnalyticsGetRequest
      parameters:
      - name: path
        in: path
        description: Path to forward to the upstream analytics service
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        '200':
          description: Successful upstream response
          content:
            application/json:
              schema:
                type: object
                description: dotCMS response envelope containing the upstream analytics data
        '400':
          description: Site identifier could not be resolved
          content:
            application/json: {}
        '401':
          description: Unauthorized – backend user required
          content:
            application/json: {}
        '403':
          description: User lacks READ permission on the resolved site (error code SITE_ACCESS_DENIED)
          content:
            application/json: {}
        '500':
          description: Internal server error or upstream unreachable
          content:
            application/json: {}

dotCMS Content Analytics API

Operations 3

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification