Matomo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Matomo Reporting API for plugin Advertising Conversion…

7 actions 7 updates phrasing extends openapi/matomo-advertisingconversionexport-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 7

$.info
$.paths['/index.php?module=API&method=AdvertisingConversionExport.getConversionExports'].get
$.paths['/index.php?module=API&method=AdvertisingConversionExport.getConversionExport'].get
$.paths['/index.php?module=API&method=AdvertisingConversionExport.deleteConversionExport'].get
$.paths['/index.php?module=API&method=AdvertisingConversionExport.addConversionExport'].get
$.paths['/index.php?module=API&method=AdvertisingConversionExport.regenerateAccessToken'].get
$.paths['/index.php?module=API&method=AdvertisingConversionExport.updateConversionExport'].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 Advertising Conversion…
  version: 1.0.0
extends: openapi/matomo-advertisingconversionexport-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: 6
- target: $.paths['/index.php?module=API&method=AdvertisingConversionExport.getConversionExports'].get
  update:
    x-apievangelist-phrasing:
      intent: List advertising conversion exports
      effect: read
      questions:
      - Which ad conversion exports have been set up for my sites?
      - Can I list conversion exports for just one website?
      instructions:
      - text: List all advertising conversion exports I can manage.
      - text: Show the conversion exports configured for site {idSite}.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AdvertisingConversionExport.getConversionExport'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one conversion export's configuration
      effect: read
      questions:
      - What settings does a specific conversion export use?
      - How is one of my ad conversion exports configured?
      instructions:
      - text: Get the configuration of conversion export {idExport}.
        slots:
          idExport: query.idExport
      - text: Show the stored settings for export {idExport}.
        slots:
          idExport: query.idExport
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AdvertisingConversionExport.deleteConversionExport'].get
  update:
    x-apievangelist-phrasing:
      intent: Delete a conversion export
      effect: destructive
      questions:
      - How do I remove an ad conversion export I no longer need?
      - Does deleting a conversion export also clear its cached file?
      instructions:
      - text: Delete conversion export {idExport} on site {idSite}.
        slots:
          idExport: query.idExport
          idSite: query.idSite
      - text: Remove export {idExport} from site {idSite} and clear its cached output.
        slots:
          idExport: query.idExport
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AdvertisingConversionExport.addConversionExport'].get
  update:
    x-apievangelist-phrasing:
      intent: Create an advertising conversion export
      effect: write
      questions:
      - How do I set up an export of conversions to upload to an ad platform?
      - Can I give a new conversion export a name and description?
      instructions:
      - text: Create a {type} conversion export named {name} for site {idSite} with parameters {parameters}.
        slots:
          type: query.type
          name: query.name
          idSite: query.idSite
          parameters: query.parameters
      - text: Add a new conversion export {name} of type {type} on site {idSite} using {parameters}, described as {description}.
        slots:
          name: query.name
          type: query.type
          idSite: query.idSite
          parameters: query.parameters
          description: query.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AdvertisingConversionExport.regenerateAccessToken'].get
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a conversion export's access token
      effect: destructive
      questions:
      - How do I invalidate the download link for a conversion export?
      - Can I issue a new access token for downloading an export?
      instructions:
      - text: Regenerate the access token for conversion export {idExport}.
        slots:
          idExport: query.idExport
      - text: Issue a new download token for export {idExport}, replacing the old one.
        slots:
          idExport: query.idExport
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AdvertisingConversionExport.updateConversionExport'].get
  update:
    x-apievangelist-phrasing:
      intent: Update a conversion export
      effect: write
      questions:
      - How do I change the parameters of an existing conversion export?
      - Can I rename a conversion export I already created?
      instructions:
      - text: 'Update existing export {idExport} on site {idSite}: name {name}, type {type}, parameters {parameters}.'
        slots:
          idExport: query.idExport
          idSite: query.idSite
          name: query.name
          type: query.type
          parameters: query.parameters
      - text: Edit conversion export {idExport} on site {idSite} to use parameters {parameters}, keeping name {name} and type {type}.
        slots:
          idExport: query.idExport
          idSite: query.idSite
          parameters: query.parameters
          name: query.name
          type: query.type
      method: generated
      generated: '2026-10-01'