# 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 Segment Editor API
  version: 1.0.0
extends: openapi/matomo-segmenteditor-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: 9
- target: $.paths['/index.php?module=API&method=SegmentEditor.isUserCanAddNewSegment'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if I'm allowed to create segments
      effect: read
      questions:
      - Do I have permission to save a new segment?
      - Am I allowed to create stored segments on a specific site?
      instructions:
      - text: Check whether I can create a new stored segment.
      - text: Tell me if I may add segments on site {idSite}.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SegmentEditor.delete'].get
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved segment
      effect: destructive
      questions:
      - How do I delete a saved segment I no longer use?
      - Can I remove a stored segment permanently?
      instructions:
      - text: Delete stored segment {idSegment}.
        slots:
          idSegment: query.idSegment
      - text: Remove saved segment {idSegment} for good.
        slots:
          idSegment: query.idSegment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SegmentEditor.update'].get
  update:
    x-apievangelist-phrasing:
      intent: Edit a saved segment
      effect: write
      questions:
      - Can I change the conditions of a segment I already saved?
      - How do I share an existing segment with all users?
      instructions:
      - text: Update saved segment {idSegment} to name {name} with definition {definition}.
        slots:
          idSegment: query.idSegment
          name: query.name
          definition: query.definition
      - text: Change existing segment {idSegment} ({name}) to {definition} and make it visible to all users.
        slots:
          idSegment: query.idSegment
          name: query.name
          definition: query.definition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SegmentEditor.add'].get
  update:
    x-apievangelist-phrasing:
      intent: Save a new segment
      effect: write
      questions:
      - How do I save a new visitor segment, like mobile users from France, in Matomo?
      - Can a newly saved segment be pre-processed automatically for faster reports?
      instructions:
      - text: Create a segment named {name} with definition {definition}.
        slots:
          name: query.name
          definition: query.definition
      - text: Save new segment {name} = {definition} on site {idSite} with auto-archiving {autoArchive}.
        slots:
          name: query.name
          definition: query.definition
          idSite: query.idSite
          autoArchive: query.autoArchive
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SegmentEditor.star'].get
  update:
    x-apievangelist-phrasing:
      intent: Star a saved segment
      effect: write
      questions:
      - Can I mark a segment as a favorite so it shows at the top?
      - What's the way to star one of my segments?
      instructions:
      - text: Star segment {idSegment}.
        slots:
          idSegment: query.idSegment
      - text: Mark saved segment {idSegment} as a favorite.
        slots:
          idSegment: query.idSegment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SegmentEditor.unstar'].get
  update:
    x-apievangelist-phrasing:
      intent: Unstar a saved segment
      effect: write
      questions:
      - How do I remove the star from a segment?
      - Can I un-favorite a segment I starred earlier?
      instructions:
      - text: Unstar segment {idSegment}.
        slots:
          idSegment: query.idSegment
      - text: Remove segment {idSegment} from my favorites.
        slots:
          idSegment: query.idSegment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SegmentEditor.get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved segment by ID
      effect: read
      questions:
      - What's the definition of a specific saved segment?
      - Can I look up one stored segment by its ID?
      instructions:
      - text: Get stored segment {idSegment}.
        slots:
          idSegment: query.idSegment
      - text: Show the name and definition of segment {idSegment}.
        slots:
          idSegment: query.idSegment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SegmentEditor.getAll'].get
  update:
    x-apievangelist-phrasing:
      intent: List all saved segments
      effect: read
      questions:
      - Which segments have been saved so far?
      - Can I list only the segments available on one site?
      instructions:
      - text: List all stored segments.
      - text: Show every saved segment available for site {idSite}.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=SegmentEditor.getSegmentData'].get
  update:
    x-apievangelist-phrasing:
      intent: Get visit totals for a segment
      effect: read
      questions:
      - How many visits and actions did a segment have over a period?
      - Can I see how a pre-processed segment's visits evolved over time?
      instructions:
      - text: Get visit and action totals for segment {segment} on site {idSite}, {period} {date}.
        slots:
          segment: query.segment
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show the visit evolution of segment {segment} for site {idSite} over {period} {date}.
        slots:
          segment: query.segment
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'