Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Analytics API

3 actions 3 updates phrasing extends openapi/confluence-analytics-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluence's API. It is a proposal applied on top of the contract, not a document Confluence publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/wiki/rest/api/analytics/content/{contentId}/views'].get
$.paths['/wiki/rest/api/analytics/content/{contentId}/viewers'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Cloud REST Analytics API
  version: 1.0.0
extends: openapi/confluence-analytics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/wiki/rest/api/analytics/content/{contentId}/views'].get
  update:
    x-apievangelist-phrasing:
      intent: Count total views of content
      effect: read
      questions:
      - How many times has a page been viewed?
      - Can I count page views since a certain date?
      instructions:
      - text: Get the total views of content {contentId}.
        slots:
          contentId: path.contentId
      - text: Count views of page {contentId} since {fromDate}.
        slots:
          contentId: path.contentId
          fromDate: query.fromDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/analytics/content/{contentId}/viewers'].get
  update:
    x-apievangelist-phrasing:
      intent: Count distinct viewers of content
      effect: read
      questions:
      - How many different people have viewed a page?
      - Can I count unique viewers of content since a date?
      instructions:
      - text: Get the number of distinct viewers of content {contentId}.
        slots:
          contentId: path.contentId
      - text: Count unique viewers of page {contentId} since {fromDate}.
        slots:
          contentId: path.contentId
          fromDate: query.fromDate
      method: generated
      generated: '2026-10-01'