Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online SEO Index API

14 actions 14 updates phrasing extends openapi/live-direct-marketing-online-seo-index-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 14

$.info
$.paths['/api/seo-index/overview'].get
$.paths['/api/seo-index/segments'].get
$.paths['/api/seo-index/sitemaps'].get
$.paths['/api/seo-index/pages'].get
$.paths['/api/seo-index/queries'].get
$.paths['/api/seo-index/history'].get
$.paths['/api/seo-index/coverage'].get
$.paths['/api/seo-index/index-coverage'].get
$.paths['/api/seo-index/yandex/overview'].get
$.paths['/api/seo-index/yandex/queries'].get
$.paths['/api/seo-index/yandex/sitemaps'].get
$.paths['/api/seo-index/indexnow'].get
$.paths['/api/seo-index/indexnow'].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 Live Direct Marketing Online SEO Index API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-seo-index-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: 13
- target: $.paths['/api/seo-index/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize Google search performance
      effect: read
      questions:
      - How are my site's search clicks and impressions trending over the last 28 days?
      - Did my average search position and CTR improve versus the previous period?
      instructions:
      - text: Summarize my search clicks, impressions, CTR and position over 7, 28 and 90 days.
      - text: Show the SEO overview with change versus the prior period.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down search metrics by site section
      effect: read
      questions:
      - Which sections of my site bring in the most search clicks?
      - Can I compare search performance across site sections for a given window?
      instructions:
      - text: Break down search metrics by site section for the last {days} days.
        slots:
          days: query.days
      - text: Compare clicks per site section over {days} days.
        slots:
          days: query.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/sitemaps'].get
  update:
    x-apievangelist-phrasing:
      intent: Check Google sitemap status
      effect: read
      questions:
      - Are my sitemaps submitted and showing errors in Google Search Console?
      - When were my sitemaps last uploaded and how many URLs were submitted?
      instructions:
      - text: Show the status of my Search Console sitemaps.
      - text: List my sitemaps with submitted counts and errors.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/pages'].get
  update:
    x-apievangelist-phrasing:
      intent: List top pages by search clicks
      effect: read
      questions:
      - Which pages on my site get the most clicks from search?
      - Can I see the top-clicked pages for just one site section?
      instructions:
      - text: List top pages by clicks in section {section}, page {page} of {pageSize}.
        slots:
          section: query.section
          page: query.page
          pageSize: query.pageSize
      - text: Show the most-clicked pages in the {section} section.
        slots:
          section: query.section
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/queries'].get
  update:
    x-apievangelist-phrasing:
      intent: List top Google search queries
      effect: read
      questions:
      - What search terms are people using to find my site on Google?
      - Which queries drive the most clicks in Search Console?
      instructions:
      - text: List my top Google search queries by clicks, page {page} with {pageSize} rows.
        slots:
          page: query.page
          pageSize: query.pageSize
      - text: Show the Search Console queries sending me the most clicks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart daily search metrics
      effect: read
      questions:
      - Can I get a day-by-day series of clicks and impressions to chart?
      - What did daily search position look like for one segment?
      instructions:
      - text: Get daily clicks and impressions for {days} days, segment {segment}, property {property}.
        slots:
          days: query.days
          segment: query.segment
          property: query.property
      - text: Build a daily SEO series for segment {segment} over {days} days.
        slots:
          segment: query.segment
          days: query.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/coverage'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare sitemap URLs to pages with impressions
      effect: read
      questions:
      - How many of my sitemap URLs actually show up in search impressions?
      - What share of my sitemap pages get any search visibility?
      instructions:
      - text: Compare my sitemap URL count with pages that have impressions.
      - text: Show search coverage of my sitemap URLs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/index-coverage'].get
  update:
    x-apievangelist-phrasing:
      intent: Count sitemap pages per surface
      effect: read
      questions:
      - How many sitemap pages does each surface like landing, blog or check have?
      - Does the index coverage report tell me which pages are indexed?
      instructions:
      - text: Show total sitemap page counts per surface.
      - text: Count sitemap pages for landing, blog, check and email-stats surfaces.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/yandex/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize Yandex search performance
      effect: read
      questions:
      - How is my site performing in Yandex search?
      - What is my Yandex site quality index and how many pages are in Yandex search?
      instructions:
      - text: Show my Yandex.Webmaster overview with clicks, impressions and quality index.
      - text: Summarize Yandex search performance per host.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/yandex/queries'].get
  update:
    x-apievangelist-phrasing:
      intent: List top Yandex search queries
      effect: read
      questions:
      - Which Yandex queries bring visitors to my site?
      - Can I page through my top Yandex.Webmaster search terms?
      instructions:
      - text: List my top Yandex search queries, page {page} with {pageSize} rows.
        slots:
          page: query.page
          pageSize: query.pageSize
      - text: Show the Yandex.Webmaster queries with the most clicks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/yandex/sitemaps'].get
  update:
    x-apievangelist-phrasing:
      intent: Check Yandex sitemap status
      effect: read
      questions:
      - When did Yandex last crawl my sitemaps?
      - Are there errors in my sitemaps in Yandex.Webmaster?
      instructions:
      - text: Show my Yandex.Webmaster sitemaps with errors and last crawl date.
      - text: List the sitemaps Yandex knows about.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/indexnow'].get
  update:
    x-apievangelist-phrasing:
      intent: Check IndexNow ping status
      effect: read
      questions:
      - Is an IndexNow key configured for my site?
      - When was the last IndexNow ping sent and how many URLs did it include?
      instructions:
      - text: Show the IndexNow ping status.
      - text: Tell me when IndexNow last pinged and in which mode.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/seo-index/indexnow'].post
  update:
    x-apievangelist-phrasing:
      intent: Force an IndexNow ping of the full sitemap
      effect: write
      questions:
      - Can I push all my sitemap URLs to IndexNow right now instead of waiting 12 hours?
      - How do I notify search engines after a bulk sitemap change?
      instructions:
      - text: Force an IndexNow ping of the entire sitemap now.
      - text: Resubmit every sitemap URL to IndexNow without waiting for the cron.
      method: generated
      generated: '2026-10-01'