Constant Contact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AppConnect V3 Contacts Reporting API

4 actions 4 updates phrasing extends openapi/constant-contact-contacts-reporting-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Constant Contact's API. It is a proposal applied on top of the contract, not a document Constant Contact publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/reports/contact_reports/{contact_id}/activity_details'].get
$.paths['/reports/contact_reports/{contact_id}/open_and_click_rates'].get
$.paths['/reports/contact_reports/{contact_id}/activity_summary'].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 AppConnect V3 Contacts Reporting API
  version: 1.0.0
extends: openapi/constant-contact-contacts-reporting-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: 3
- target: $.paths['/reports/contact_reports/{contact_id}/activity_details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact's tracking activity
      effect: read
      questions:
      - What has a contact opened, clicked or bounced recently?
      - Can I filter a contact's activity to just clicks?
      instructions:
      - text: Show tracking activity for contact {contact_id}.
        slots:
          contact_id: path.contact_id
      - text: List {tracking_activity_type} activity for contact {contact_id}.
        slots:
          contact_id: path.contact_id
          tracking_activity_type: query.tracking_activity_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/contact_reports/{contact_id}/open_and_click_rates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact's average open and click rates
      effect: read
      questions:
      - What is a contact's average open and click rate?
      - Can I calculate open rate for a contact over a date range up to five years?
      instructions:
      - text: Get average open and click rates for contact {contact_id} from {start} to {end}.
        slots:
          contact_id: path.contact_id
          start: query.start
          end: query.end
      - text: Show how often contact {contact_id} opened and clicked between {start} and {end}.
        slots:
          contact_id: path.contact_id
          start: query.start
          end: query.end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/contact_reports/{contact_id}/activity_summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize a contact's actions per email
      effect: read
      questions:
      - Which recent emails did a contact receive and what did they do with each?
      - Is there a per-campaign summary of a contact's opens and clicks?
      instructions:
      - text: Summarize actions by contact {contact_id} on emails from {start} to {end}.
        slots:
          contact_id: path.contact_id
          start: query.start
          end: query.end
      - text: List recent campaigns sent to contact {contact_id} between {start} and {end} with their actions.
        slots:
          contact_id: path.contact_id
          start: query.start
          end: query.end
      method: generated
      generated: '2026-10-01'