Matomo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Matomo Reporting API for plugin Search Engine Keywords…

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

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywords'].get
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsImported'].get
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsGoogle'].get
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsBing'].get
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsYandex'].get
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsGoogleWeb'].get
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsGoogleImage'].get
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsGoogleVideo'].get
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsGoogleNews'].get
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getCrawlingOverviewBing'].get
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getCrawlingOverviewYandex'].get
$.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getCrawlingErrorExamplesBing'].get

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 Matomo Reporting API for plugin Search Engine Keywords…
  version: 1.0.0
extends: openapi/matomo-searchenginekeywordsperformance-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: 12
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywords'].get
  update:
    x-apievangelist-phrasing:
      intent: Get search keyword performance from all sources
      effect: read
      questions:
      - Which search keywords brought visitors to my site, combining every source?
      - Can I see imported search engine keywords alongside the referrer keywords Matomo tracked itself?
      instructions:
      - text: Show combined search keyword performance for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List all keywords from every search source for site {idSite} in {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsImported'].get
  update:
    x-apievangelist-phrasing:
      intent: Get keywords imported from search engines
      effect: read
      questions:
      - What keyword data has been imported from the connected search engine consoles?
      - Can I see only imported keywords, without Matomo's own referrer keywords?
      instructions:
      - text: Show imported search engine keywords for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List only the keywords imported from search consoles for site {idSite} in {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsGoogle'].get
  update:
    x-apievangelist-phrasing:
      intent: Get keyword performance from Google
      effect: read
      questions:
      - What Google search queries is my site getting clicks and impressions for?
      - Can I see all Google keyword data across web, image, video and news combined?
      instructions:
      - text: Show Google keyword performance across all search types for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List all imported Google search keywords for site {idSite} in {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsBing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get keyword performance from Bing and Yahoo
      effect: read
      questions:
      - Which Bing and Yahoo searches send traffic to my site?
      - What keywords were imported from Bing for a given month?
      instructions:
      - text: Show Bing and Yahoo keyword performance for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List imported Bing search keywords for site {idSite} in {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsYandex'].get
  update:
    x-apievangelist-phrasing:
      intent: Get keyword performance from Yandex
      effect: read
      questions:
      - Which Yandex searches send traffic to my site?
      - What keywords were imported from Yandex for a period?
      instructions:
      - text: Show Yandex keyword performance for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List imported Yandex search keywords for site {idSite} in {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsGoogleWeb'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Google web search keyword performance
      effect: read
      questions:
      - What regular Google web search queries is my site ranking for?
      - Can I see Google keywords for web results only, excluding images and news?
      instructions:
      - text: Show Google web search keywords for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List keywords from Google's standard web results for site {idSite} in {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsGoogleImage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Google image search keyword performance
      effect: read
      questions:
      - Which Google Images searches lead people to my pictures?
      - What keywords drive traffic from Google image search?
      instructions:
      - text: Show Google image search keywords for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List keywords from Google Images results for site {idSite} in {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsGoogleVideo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Google video search keyword performance
      effect: read
      questions:
      - Which Google video search queries surface my content?
      - What keywords drive traffic from Google's video results?
      instructions:
      - text: Show Google video search keywords for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List keywords from Google video results for site {idSite} in {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getKeywordsGoogleNews'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Google News search keyword performance
      effect: read
      questions:
      - Which Google News searches bring readers to my articles?
      - What keywords drive traffic from Google news results?
      instructions:
      - text: Show Google News search keywords for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List keywords from Google news results for site {idSite} in {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getCrawlingOverviewBing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Bing crawl overview metrics
      effect: read
      questions:
      - How often is Bing crawling my site and how many pages are indexed?
      - What do Bing's crawl stats look like for a given period?
      instructions:
      - text: Show the Bing crawl overview for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Get Bing crawling metrics for site {idSite} in {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getCrawlingOverviewYandex'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Yandex crawl overview metrics
      effect: read
      questions:
      - How often is Yandex crawling my site?
      - What do Yandex's crawl stats look like for a given period?
      instructions:
      - text: Show the Yandex crawl overview for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Get Yandex crawling metrics for site {idSite} in {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SearchEngineKeywordsPerformance.getCrawlingErrorExamplesBing'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent Bing crawl error examples
      effect: read
      questions:
      - Which of my pages did Bing fail to crawl recently?
      - Can I see example URLs with Bing crawl errors?
      instructions:
      - text: List the latest Bing crawl error examples for site {idSite}.
        slots:
          idSite: query.idSite
      - text: Show sample URLs Bing could not crawl on site {idSite}.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'