Constant Contact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AppConnect V3 Email Reporting API

13 actions 13 updates phrasing extends openapi/constant-contact-email-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 13

$.info
$.paths['/reports/email_reports/{campaign_activity_id}/links'].get
$.paths['/reports/email_reports/{campaign_activity_id}/tracking/sends'].get
$.paths['/reports/email_reports/{campaign_activity_id}/tracking/opens'].get
$.paths['/reports/email_reports/{campaign_activity_id}/tracking/unique_opens'].get
$.paths['/reports/email_reports/{campaign_activity_id}/tracking/didnotopens'].get
$.paths['/reports/email_reports/{campaign_activity_id}/tracking/clicks'].get
$.paths['/reports/email_reports/{campaign_activity_id}/tracking/forwards'].get
$.paths['/reports/email_reports/{campaign_activity_id}/tracking/optouts'].get
$.paths['/reports/email_reports/{campaign_activity_id}/tracking/bounces'].get
$.paths['/reports/summary_reports/email_campaign_summaries'].get
$.paths['/reports/stats/email_campaigns/{campaign_ids}'].get
$.paths['/reports/stats/email_campaign_activities/{campaign_activity_ids}'].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 Email Reporting API
  version: 1.0.0
extends: openapi/constant-contact-email-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: 12
- target: $.paths['/reports/email_reports/{campaign_activity_id}/links'].get
  update:
    x-apievangelist-phrasing:
      intent: Report clicks per link in an email
      effect: read
      questions:
      - Which links in my email got the most unique clicks?
      - Can the links report also show links nobody clicked?
      instructions:
      - text: Show link click stats for {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: List every link in {campaign_activity_id}, including unclicked ones ({no_clicks}).
        slots:
          campaign_activity_id: path.campaign_activity_id
          no_clicks: query.no_clicks
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/email_reports/{campaign_activity_id}/tracking/sends'].get
  update:
    x-apievangelist-phrasing:
      intent: Report who an email was sent to
      effect: read
      questions:
      - Which contacts was a particular email actually sent to?
      - When exactly did each contact receive my email?
      instructions:
      - text: List contacts sent email activity {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: Get the sends report for {campaign_activity_id}, {limit} per page.
        slots:
          campaign_activity_id: path.campaign_activity_id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/email_reports/{campaign_activity_id}/tracking/opens'].get
  update:
    x-apievangelist-phrasing:
      intent: Report every open of an email
      effect: read
      questions:
      - Every time someone opened my email — when and on what device?
      - Can I see repeat opens, not just the first one?
      instructions:
      - text: List every open of email activity {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: Get all opens, including repeats, for {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/email_reports/{campaign_activity_id}/tracking/unique_opens'].get
  update:
    x-apievangelist-phrasing:
      intent: Report unique openers of an email
      effect: read
      questions:
      - Who opened my email, counting each contact only once?
      - When was the last time each contact opened a campaign?
      instructions:
      - text: List unique openers of {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: Get the unique opens report for {campaign_activity_id}, one row per contact.
        slots:
          campaign_activity_id: path.campaign_activity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/email_reports/{campaign_activity_id}/tracking/didnotopens'].get
  update:
    x-apievangelist-phrasing:
      intent: Report contacts who did not open an email
      effect: read
      questions:
      - Which contacts received my email but never opened it?
      - Can I get a list of non-openers to follow up with?
      instructions:
      - text: List contacts who didn't open {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: Get the did-not-open report for {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/email_reports/{campaign_activity_id}/tracking/clicks'].get
  update:
    x-apievangelist-phrasing:
      intent: Report clicks on an email
      effect: read
      questions:
      - Who clicked links in my email and when?
      - Can I see clicks for just one specific link?
      instructions:
      - text: List clicks on email activity {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: Show who clicked link {url_id} in {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
          url_id: query.url_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/email_reports/{campaign_activity_id}/tracking/forwards'].get
  update:
    x-apievangelist-phrasing:
      intent: Report forwards of an email
      effect: read
      questions:
      - Who forwarded my email using the footer forward link?
      - Is there a report of email forwards by contact?
      instructions:
      - text: List forwards of {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: Get the forwards report for email activity {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/email_reports/{campaign_activity_id}/tracking/optouts'].get
  update:
    x-apievangelist-phrasing:
      intent: Report unsubscribes from an email
      effect: read
      questions:
      - Which contacts unsubscribed after this email?
      - Can I see opt-out reasons for a specific campaign?
      instructions:
      - text: List opt-outs from {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: Show who unsubscribed via email activity {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/email_reports/{campaign_activity_id}/tracking/bounces'].get
  update:
    x-apievangelist-phrasing:
      intent: Report bounces for an email
      effect: read
      questions:
      - Which email addresses bounced on my last send?
      - Can I filter bounces by bounce code, like non-existent address?
      instructions:
      - text: List bounces for {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: Show bounces with code {bounce_code} for {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
          bounce_code: query.bounce_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/summary_reports/email_campaign_summaries'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize stats across all email campaigns
      effect: read
      questions:
      - How are my email campaigns performing overall?
      - Can I get aggregate open and click counts for up to 500 campaigns?
      instructions:
      - text: Get the email campaigns summary report.
      - text: Summarize my last {limit} email campaigns.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/stats/email_campaigns/{campaign_ids}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance stats for chosen campaigns
      effect: read
      questions:
      - What are the open, click and bounce totals for specific campaigns?
      - Can I compare stats for a few email campaigns by their IDs?
      instructions:
      - text: Get performance stats for campaigns {campaign_ids}.
        slots:
          campaign_ids: path.campaign_ids
      - text: Show interaction totals for email campaigns {campaign_ids}.
        slots:
          campaign_ids: path.campaign_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/stats/email_campaign_activities/{campaign_activity_ids}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stats for specific email activities
      effect: read
      questions:
      - What are the stats for up to ten individual email campaign activities?
      - Is there a per-activity performance report rather than per-campaign?
      instructions:
      - text: Get stats for campaign activities {campaign_activity_ids}.
        slots:
          campaign_activity_ids: path.campaign_activity_ids
      - text: Show interaction counts for email activities {campaign_activity_ids}.
        slots:
          campaign_activity_ids: path.campaign_activity_ids
      method: generated
      generated: '2026-10-01'