DataForSEO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataForSEO On Page API

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

What the actions change

x-apievangelist-phrasing

Targets 31 · first 16 shown; the file carries all of them

$.info
$.paths['/v3/on_page/id_list'].post
$.paths['/v3/on_page/errors'].post
$.paths['/v3/on_page/force_stop'].post
$.paths['/v3/on_page/available_filters'].get
$.paths['/v3/on_page/task_post'].post
$.paths['/v3/on_page/tasks_ready'].get
$.paths['/v3/on_page/summary/{id}'].get
$.paths['/v3/on_page/pages'].post
$.paths['/v3/on_page/pages_by_resource'].post
$.paths['/v3/on_page/resources'].post
$.paths['/v3/on_page/duplicate_tags'].post
$.paths['/v3/on_page/duplicate_content'].post
$.paths['/v3/on_page/links'].post
$.paths['/v3/on_page/redirect_chains'].post
$.paths['/v3/on_page/non_indexable'].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 DataForSEO On Page API
  version: 1.0.0
extends: openapi/dataforseo-onpage-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: 30
- target: $.paths['/v3/on_page/id_list'].post
  update:
    x-apievangelist-phrasing:
      intent: List On-Page task IDs for a time period
      effect: read
      questions:
      - Can I get the IDs of every site crawl task I created within a date range?
      - Does the On-Page task ID list include crawls that haven't finished?
      instructions:
      - text: List the IDs and metadata of all my On-Page crawl tasks from last week.
      - text: Pull the On-Page task ID list for last month, including incomplete crawls.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/errors'].post
  update:
    x-apievangelist-phrasing:
      intent: List On-Page tasks that failed recently
      effect: read
      questions:
      - Which of my site audit tasks returned errors in the past 7 days?
      - Where can I see why an On-Page crawl request failed?
      instructions:
      - text: Show On-Page tasks that errored in the last 7 days.
      - text: List recent site crawl task errors so I can debug them.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/force_stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Force stop a running website crawl
      effect: destructive
      questions:
      - Can I stop a website crawl that's still running?
      - If I halt a crawl early, do I keep the data for pages already scanned?
      instructions:
      - text: Force stop the crawl for my site audit task now.
      - text: Halt these running On-Page crawl tasks and keep what was scanned.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/available_filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters and thresholds for On-Page
      effect: read
      questions:
      - What filters and performance thresholds can I use with On-Page audit results?
      - Which page check fields can I filter crawled pages by?
      instructions:
      - text: Show the filters and thresholds available for On-Page endpoints.
      - text: Get the list of On-Page filter fields.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/task_post'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a website crawl and audit
      effect: write
      questions:
      - How do I start an SEO audit that crawls my whole website?
      - Can a site crawl check meta tags, duplicate content, images and response codes on every page?
      instructions:
      - text: Start an On-Page crawl of my website with a 500-page limit.
      - text: Launch a full site audit for this domain and check 60+ on-page parameters.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/tasks_ready'].get
  update:
    x-apievangelist-phrasing:
      intent: List completed site crawl tasks
      effect: read
      questions:
      - Which of my site crawls have finished but haven't been collected yet?
      - How do I know when an On-Page audit is ready to read?
      instructions:
      - text: List my completed On-Page crawl tasks awaiting collection.
      - text: Check which site audits are ready.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/summary/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the audit summary of a crawled site
      effect: read
      questions:
      - What's the overall health and list of issues for a site I crawled?
      - Can I see a crawl's progress and issue counts before drilling into details?
      instructions:
      - text: Get the On-Page summary for crawl task {id}.
        slots:
          id: path.id
      - text: Show the site issues overview for audit {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: List crawled pages with their checks
      effect: read
      questions:
      - Which crawled pages failed on-page checks like missing titles or slow load?
      - Can I list every page from my audit with its optimization metrics?
      instructions:
      - text: List all crawled pages from my audit with their on-page check results.
      - text: Show pages from the crawl that are missing a meta description.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/pages_by_resource'].post
  update:
    x-apievangelist-phrasing:
      intent: Find pages that contain a resource
      effect: read
      questions:
      - Which pages on my site load a specific image or script?
      - Where is a broken resource used across my crawled pages?
      instructions:
      - text: Find every crawled page that uses this resource URL.
      - text: List the pages where this broken image appears.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/resources'].post
  update:
    x-apievangelist-phrasing:
      intent: List images, scripts and stylesheets found
      effect: read
      questions:
      - What images, scripts and stylesheets did the crawler find on my site?
      - Are there broken resources on any of my crawled pages?
      instructions:
      - text: List all resources found in my site crawl, including broken ones.
      - text: Show the oversized images and scripts detected in the audit.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/duplicate_tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Find pages with duplicate titles or descriptions
      effect: read
      questions:
      - Which pages on my site share the same title tag?
      - Do any crawled pages have duplicate meta descriptions?
      instructions:
      - text: List pages with duplicate title tags from my crawl.
      - text: Find pages that reuse the same meta description.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/duplicate_content'].post
  update:
    x-apievangelist-phrasing:
      intent: Find pages with content similar to a page
      effect: read
      questions:
      - Which pages on my site have content too similar to a given page?
      - How similar is the near-duplicate content, as a similarity score?
      instructions:
      - text: Find pages whose content duplicates this URL from my crawl.
      - text: Show near-duplicate content pages with their similarity index.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/links'].post
  update:
    x-apievangelist-phrasing:
      intent: List internal and external links on a site
      effect: read
      questions:
      - What internal and external links did the crawler find on my website?
      - Can I filter crawled links by type, like canonical, image or redirect?
      instructions:
      - text: List all internal and external links detected on my crawled site.
      - text: Show only canonical and alternate links from the audit.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/redirect_chains'].post
  update:
    x-apievangelist-phrasing:
      intent: Find redirect chains and loops
      effect: read
      questions:
      - Does my site have redirect chains with two or more hops?
      - Are any of my pages stuck in a redirect loop?
      instructions:
      - text: List the redirect chains found in my site crawl.
      - text: Find redirect loops across my crawled pages.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/non_indexable'].post
  update:
    x-apievangelist-phrasing:
      intent: List pages blocked from search indexing
      effect: read
      questions:
      - Which pages are blocked from Google by robots.txt, headers or meta tags?
      - Why isn't a page on my site indexable?
      instructions:
      - text: List the non-indexable pages from my crawl and why they're blocked.
      - text: Show pages hidden from search engines by noindex or robots.txt.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/waterfall'].post
  update:
    x-apievangelist-phrasing:
      intent: Get page load timing waterfall
      effect: read
      questions:
      - How long does each resource on my page take to load?
      - What's the connection and time-to-secure-connection breakdown for a crawled page?
      instructions:
      - text: Show the page speed waterfall for this URL from my crawl.
      - text: Break down load timing for every resource on this page.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/keyword_density'].post
  update:
    x-apievangelist-phrasing:
      intent: Get keyword density for a site or page
      effect: read
      questions:
      - Which terms appear most often on my website or a specific page?
      - What's the keyword density and frequency of phrases on my crawled pages?
      instructions:
      - text: Show keyword density and frequency for my crawled site.
      - text: Get the most frequent two-word phrases on this page.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/microdata'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate structured data on a page
      effect: read
      questions:
      - Is the JSON-LD and Microdata on my page valid?
      - What structured data errors did the crawler find on a page?
      instructions:
      - text: Validate the JSON-LD and Microdata on this crawled page.
      - text: Show structured data validation results for this URL.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/raw_html'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the stored HTML of a crawled page
      effect: read
      questions:
      - Can I see the HTML the crawler stored for a page in my audit?
      - What source code did the site crawl capture for a URL?
      instructions:
      - text: Return the raw HTML of this page from my crawl.
      - text: Get the crawled HTML source for this URL.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/page_screenshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture a full-page screenshot
      effect: read
      questions:
      - Can I see a screenshot of a page the way Googlebot sees it?
      - How do I capture a full high-quality screenshot of any webpage?
      instructions:
      - text: Take a full-page screenshot of this URL.
      - text: Capture how my homepage looks to the crawler.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/content_parsing'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse content of a crawled page
      effect: read
      questions:
      - Can I extract the headings, links and text of a page from my site crawl?
      - What structured content did the audit parse from a crawled URL?
      instructions:
      - text: Parse the structured content of this page from my existing crawl.
      - text: Extract headings and anchors from a crawled page in my audit.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/content_parsing/live'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse any page's content live
      effect: read
      questions:
      - Can I extract the headings, links and text of any URL instantly without a crawl task?
      - Is there a real-time way to turn a webpage into structured content?
      instructions:
      - text: Parse this URL's content live and return headings, links and text.
      - text: Extract structured content from any page right now, no crawl needed.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/instant_pages'].post
  update:
    x-apievangelist-phrasing:
      intent: Audit a single page instantly
      effect: read
      questions:
      - How well is a single page optimized for organic search, checked instantly?
      - Can I get on-page SEO data for one URL without crawling the whole site?
      instructions:
      - text: Run an instant on-page SEO check on this single URL.
      - text: Audit just this landing page for optimization issues.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/lighthouse/languages'].get
  update:
    x-apievangelist-phrasing:
      intent: List languages for Lighthouse reports
      effect: read
      questions:
      - In which languages can Lighthouse audit reports be returned?
      - Can I get a Lighthouse report localized to my language?
      instructions:
      - text: List the languages supported for Lighthouse audits.
      - text: Get the Lighthouse report language codes.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/lighthouse/audits'].get
  update:
    x-apievangelist-phrasing:
      intent: List available Lighthouse audits
      effect: read
      questions:
      - Which individual Lighthouse audits can I request?
      - What audit names can I include in a Lighthouse check?
      instructions:
      - text: List all available Lighthouse audits.
      - text: Show the Lighthouse audit names I can select.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/lighthouse/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported Lighthouse versions
      effect: read
      questions:
      - Which Lighthouse versions are available for page quality audits?
      - Can I pin my audit to a specific Lighthouse version?
      instructions:
      - text: List the supported Lighthouse versions.
      - text: Get the Lighthouse versions I can run audits with.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/lighthouse/task_post'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a Lighthouse audit of a page
      effect: write
      questions:
      - How do I queue a Lighthouse audit for a URL and fetch it later?
      - Can I submit a background Lighthouse performance and accessibility check?
      instructions:
      - text: Queue a Lighthouse audit for my homepage.
      - text: Submit a background Lighthouse task for this URL on mobile.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/lighthouse/tasks_ready'].get
  update:
    x-apievangelist-phrasing:
      intent: List completed Lighthouse tasks
      effect: read
      questions:
      - Which Lighthouse audits I queued are finished but not yet collected?
      - How can I find ready Lighthouse results without a postback URL?
      instructions:
      - text: List my completed Lighthouse tasks waiting to be collected.
      - text: Check which Lighthouse audits are ready.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/lighthouse/task_get/json/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get results of a queued Lighthouse audit
      effect: read
      questions:
      - How do I retrieve the Lighthouse report for an audit I queued?
      - Does a queued Lighthouse result include performance, accessibility and SEO scores?
      instructions:
      - text: Get the Lighthouse JSON results for task {id}.
        slots:
          id: path.id
      - text: Fetch performance and SEO scores from Lighthouse audit {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/on_page/lighthouse/live/json'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a live Lighthouse audit
      effect: read
      questions:
      - Can I run a Lighthouse audit on a page and get the results immediately?
      - What are my page's Lighthouse scores right now, without queuing a task?
      instructions:
      - text: Run a live Lighthouse audit on this URL and return JSON.
      - text: Get real-time Lighthouse scores for my landing page.
      method: generated
      generated: '2026-10-01'