Generated by API Evangelist
Written by API Evangelist tooling for dotCMS's API. It is a proposal applied on top of the contract, not a document dotCMS publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for dotCMS REST Content Analytics API
version: 1.0.0
extends: openapi/dotcms-content-analytics-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/api/v1/analytics/content/siteauth/generate/{siteId}'].get
update:
x-apievangelist-phrasing:
intent: Generate a site key for analytics events
effect: write
questions:
- 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?
instructions:
- text: Generate a Content Analytics site key for site {siteId}.
slots:
siteId: path.siteId
- text: Create the site auth key for {siteId} so the client JS can post events.
slots:
siteId: path.siteId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/analytics/content/event'].post
update:
x-apievangelist-phrasing:
intent: Send a custom analytics event
effect: write
questions:
- How do I record a custom Content Analytics event from my site?
- What happens if the site_auth in my event payload is invalid?
instructions:
- text: Send this custom analytics event with its site_auth key.
- text: Ingest a Content Analytics event for the active site.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/analytics/{path}'].get
update:
x-apievangelist-phrasing:
intent: Query Content Analytics data
effect: read
questions:
- Can I query Content Analytics reports through dotCMS for a site I can read?
- Which analytics GET route forwards my query parameters upstream?
instructions:
- text: Query Content Analytics at path {path}.
slots:
path: path.path
- text: Fetch analytics data from {path} for my current site.
slots:
path: path.path
method: generated
generated: '2026-09-26'
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.