# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Marketing Campaigns Public Metrics API
  version: 1.0.0
extends: openapi/hubspot-metrics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/marketing/campaigns/2026-03/{campaignGuid}/reports/contacts/{contactType}'].get
  update:
    x-apievangelist-phrasing:
      intent: List contacts a campaign reached
      effect: read
      questions:
      - Which contact IDs did my marketing campaign influence?
      - Can I pull a campaign's contact list for just one date range?
      instructions:
      - text: Get the {contactType} contact IDs for campaign {campaignGuid}.
        slots:
          contactType: path.contactType
          campaignGuid: path.campaignGuid
      - text: List {contactType} contacts for campaign {campaignGuid} between {startDate} and {endDate}.
        slots:
          contactType: path.contactType
          campaignGuid: path.campaignGuid
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-24'
- target: $.paths['/marketing/campaigns/2026-03/{campaignGuid}/reports/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign's attribution metrics
      effect: read
      questions:
      - How many sessions and new contacts did my campaign drive?
      - What are a campaign's influenced contact counts for last month?
      instructions:
      - text: Show sessions, new contacts and influenced contacts for campaign {campaignGuid}.
        slots:
          campaignGuid: path.campaignGuid
      - text: Get attribution metrics for campaign {campaignGuid} from {startDate} to {endDate}.
        slots:
          campaignGuid: path.campaignGuid
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-24'
- target: $.paths['/marketing/campaigns/2026-03/{campaignGuid}/reports/revenue'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign's attributed revenue
      effect: read
      questions:
      - How much deal revenue is attributed to my campaign?
      - Can I change the attribution model used for campaign revenue?
      instructions:
      - text: Show attributed revenue for campaign {campaignGuid}.
        slots:
          campaignGuid: path.campaignGuid
      - text: Get revenue for campaign {campaignGuid} using the {attributionModel} model.
        slots:
          campaignGuid: path.campaignGuid
          attributionModel: query.attributionModel
      method: generated
      generated: '2026-09-24'