# 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 Actions API
  version: 1.0.0
extends: openapi/matomo-actions-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: 18
- target: $.paths['/index.php?module=API&method=Actions.get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get overall action metrics for a period
      effect: read
      questions:
      - How many pageviews, downloads and outlinks did my site get last month?
      - What are the total action counts for a site in a date range?
      instructions:
      - text: Show aggregated action metrics for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Get only the {columns} action totals for site {idSite} in {period} {date}.
        slots:
          columns: query.columns
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getPageUrls'].get
  update:
    x-apievangelist-phrasing:
      intent: Report traffic per page URL
      effect: read
      questions:
      - Which pages on my site get the most pageviews?
      - Can I see page URL metrics as a flat list instead of folders?
      instructions:
      - text: Show the page URLs report for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List page URL metrics for site {idSite} in {period} {date}, flattened.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getPageUrlsFollowingSiteSearch'].get
  update:
    x-apievangelist-phrasing:
      intent: Report page URLs visited after site search
      effect: read
      questions:
      - Which pages do people open right after using my site search?
      - Where do visitors land after searching on my site, by URL?
      instructions:
      - text: Show page URLs viewed after an internal search on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List destination URLs following site search for site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getPageTitlesFollowingSiteSearch'].get
  update:
    x-apievangelist-phrasing:
      intent: Report page titles visited after site search
      effect: read
      questions:
      - Which page titles do visitors view immediately after searching my site?
      - What content do searchers go to next, by page title?
      instructions:
      - text: Show page titles viewed after an internal search on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List page titles that followed site search for site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getEntryPageUrls'].get
  update:
    x-apievangelist-phrasing:
      intent: Report entry page URLs
      effect: read
      questions:
      - Which URLs do visitors land on first when they arrive?
      - What are my top landing page URLs this week?
      instructions:
      - text: Show entry page URLs for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List every landing page URL with its metrics for site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getExitPageUrls'].get
  update:
    x-apievangelist-phrasing:
      intent: Report exit page URLs
      effect: read
      questions:
      - Which page URLs do visitors leave my site from?
      - Where are people exiting the site most often, by URL?
      instructions:
      - text: Show exit page URLs for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List the URLs visitors exit from on site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getPageUrl'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for one page URL
      effect: read
      questions:
      - How many views did one specific page URL get?
      - What is the time on page for a single URL last month?
      instructions:
      - text: Get metrics for page URL {pageUrl} on site {idSite} for {period} {date}.
        slots:
          pageUrl: query.pageUrl
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show pageviews and time on page for {pageUrl} on site {idSite} in {period} {date}.
        slots:
          pageUrl: query.pageUrl
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getPageTitles'].get
  update:
    x-apievangelist-phrasing:
      intent: Report traffic per page title
      effect: read
      questions:
      - Which page titles get the most views on my site?
      - Can I see pageviews grouped by page title rather than URL?
      instructions:
      - text: Show the page titles report for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List page title metrics for site {idSite} in {period} {date}, flattened.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getEntryPageTitles'].get
  update:
    x-apievangelist-phrasing:
      intent: Report entry page titles
      effect: read
      questions:
      - Which page titles do visitors see first when entering the site?
      - What are my top landing pages by title?
      instructions:
      - text: Show entry page titles for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List landing page titles for site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getExitPageTitles'].get
  update:
    x-apievangelist-phrasing:
      intent: Report exit page titles
      effect: read
      questions:
      - Which page titles are visitors on when they leave?
      - What are the most common exit pages by title?
      instructions:
      - text: Show exit page titles for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List the page titles people exit from on site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getPageTitle'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for one page title
      effect: read
      questions:
      - How did one particular page title perform last week?
      - What are the stats for a single named page?
      instructions:
      - text: Get metrics for page title {pageName} on site {idSite} for {period} {date}.
        slots:
          pageName: query.pageName
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show views for the page titled {pageName} on site {idSite} in {period} {date}.
        slots:
          pageName: query.pageName
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getDownloads'].get
  update:
    x-apievangelist-phrasing:
      intent: Report file downloads
      effect: read
      questions:
      - Which files are downloaded most from my site?
      - How many downloads did each file get this month?
      instructions:
      - text: Show the downloads report for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List every downloaded file for site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getDownload'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for one download URL
      effect: read
      questions:
      - How many times was a specific PDF downloaded?
      - What are the download stats for one file URL?
      instructions:
      - text: Get download metrics for {downloadUrl} on site {idSite} for {period} {date}.
        slots:
          downloadUrl: query.downloadUrl
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show how often {downloadUrl} was downloaded from site {idSite} in {period} {date}.
        slots:
          downloadUrl: query.downloadUrl
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getOutlinks'].get
  update:
    x-apievangelist-phrasing:
      intent: Report outbound link clicks
      effect: read
      questions:
      - Which external links do visitors click on my site?
      - What outbound domains get the most clicks?
      instructions:
      - text: Show the outlinks report for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List clicked external links for site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getOutlink'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for one outbound link
      effect: read
      questions:
      - How many clicks did one specific external link get?
      - Is anyone clicking the link to a partner URL?
      instructions:
      - text: Get click metrics for outlink {outlinkUrl} on site {idSite} for {period} {date}.
        slots:
          outlinkUrl: query.outlinkUrl
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show how many visitors clicked {outlinkUrl} on site {idSite} in {period} {date}.
        slots:
          outlinkUrl: query.outlinkUrl
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getSiteSearchKeywords'].get
  update:
    x-apievangelist-phrasing:
      intent: Report site search keywords with results
      effect: read
      questions:
      - What are visitors searching for on my site?
      - Which internal search terms return results most often?
      instructions:
      - text: Show site search keywords for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List the internal search terms visitors used on site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getSiteSearchNoResultKeywords'].get
  update:
    x-apievangelist-phrasing:
      intent: Report site searches with no results
      effect: read
      questions:
      - Which searches on my site come back empty?
      - What content are people looking for that my site doesn't have?
      instructions:
      - text: Show site search keywords with no results for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List zero-result internal searches on site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Actions.getSiteSearchCategories'].get
  update:
    x-apievangelist-phrasing:
      intent: Report site search categories
      effect: read
      questions:
      - Which search categories do visitors pick when searching my site?
      - How is internal search usage split by category?
      instructions:
      - text: Show site search categories for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List internal search categories used on site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'