Common Room · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Common Room API (v2) Website Visits API

2 actions 2 updates phrasing extends openapi/common-room-website-visits-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Common Room's API. It is a proposal applied on top of the contract, not a document Common Room publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/website-visits'].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 Common Room API (v2) Website Visits API
  version: 1.0.0
extends: openapi/common-room-website-visits-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: 1
- target: $.paths['/website-visits'].get
  update:
    x-apievangelist-phrasing:
      intent: List website visits
      effect: read
      questions:
      - Which pages on our website have people been visiting?
      - Can I see the website visits for one contact or organization?
      instructions:
      - text: List website visits by contact {contactId}.
        slots:
          contactId: query.contactId
      - text: List website visits from organization {organizationId}.
        slots:
          organizationId: query.organizationId
      - text: List recent website visits.
      method: generated
      generated: '2026-10-01'