Profound · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for External Bot Traffic Reports API

3 actions 3 updates phrasing extends openapi/profound-bot-traffic-reports-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/bots'].post
$.paths['/v2/reports/bots'].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 Bot Traffic Reports API
  version: 1.0.0
extends: openapi/profound-bot-traffic-reports-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/bots'].post
  update:
    x-apievangelist-phrasing:
      intent: Report daily AI bot traffic to a domain
      effect: read
      questions:
      - How many AI crawler visits did my site get each day?
      - Can I see daily counts of training versus indexing bot events over a long date range?
      instructions:
      - text: Report daily bot {metrics} for {domain} since {start_date}.
        slots:
          metrics: requestBody.metrics
          domain: requestBody.domain
          start_date: requestBody.start_date
      - text: Pull the day-level crawler {metrics} for {domain} from {start_date} to {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/bots'].post
  update:
    x-apievangelist-phrasing:
      intent: Report hourly AI bot traffic to a domain
      effect: read
      questions:
      - Which AI bots hit my site hour by hour, and on which paths?
      - Can I break bot visits down by bot provider and bot type in my own timezone?
      instructions:
      - text: Show hourly bot {metrics} for {domain} starting {start_date}, grouped by {dimensions}.
        slots:
          metrics: requestBody.metrics
          domain: requestBody.domain
          start_date: requestBody.start_date
          dimensions: requestBody.dimensions
      - text: Get v2 bot {metrics} for {domain} from {start_date} at {date_interval} granularity in timezone {timezone}.
        slots:
          domain: requestBody.domain
          start_date: requestBody.start_date
          date_interval: requestBody.date_interval
          timezone: requestBody.timezone
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'