Profound · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for External Human Referrals API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/reports/referrals'].post
$.paths['/v2/reports/referrals'].post

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 External Human Referrals API
  version: 1.0.0
extends: openapi/profound-human-referrals-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['/v1/reports/referrals'].post
  update:
    x-apievangelist-phrasing:
      intent: Report daily human referrals from AI
      effect: read
      questions:
      - How much daily referral traffic are AI assistants sending to my site?
      - Can I get day-level referral numbers across a long period efficiently?
      instructions:
      - text: Report daily referral {metrics} for {domain} since {start_date}.
        slots:
          metrics: requestBody.metrics
          domain: requestBody.domain
          start_date: requestBody.start_date
      - text: Pull day-by-day referral {metrics} for {domain} between {start_date} and {end_date}.
        slots:
          domain: requestBody.domain
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/reports/referrals'].post
  update:
    x-apievangelist-phrasing:
      intent: Report hourly human referrals from AI
      effect: read
      questions:
      - Which hours of the day bring the most AI-referred visitors to my site?
      - Is there a referral report that supports hourly, quarterly or relative-week intervals?
      instructions:
      - text: Show hourly referral {metrics} for {domain} from {start_date}.
        slots:
          metrics: requestBody.metrics
          domain: requestBody.domain
          start_date: requestBody.start_date
      - text: Get v2 referral {metrics} for {domain} at {date_interval} intervals in timezone {timezone} from {start_date}.
        slots:
          domain: requestBody.domain
          date_interval: requestBody.date_interval
          timezone: requestBody.timezone
          start_date: requestBody.start_date
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'