# 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 Privacy Manager API
  version: 1.0.0
extends: openapi/matomo-privacymanager-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=PrivacyManager.deleteDataSubjects'].get
  update:
    x-apievangelist-phrasing:
      intent: Erase a data subject's visit data
      effect: destructive
      questions:
      - How do I honor a GDPR right-to-erasure request for a visitor?
      - Can I permanently delete all tracked visits for one person?
      instructions:
      - text: Delete the data subjects for visits {visits}.
        slots:
          visits: query.visits
      - text: 'Erase stored visit data for these data subjects: {visits}.'
        slots:
          visits: query.visits
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=PrivacyManager.exportDataSubjects'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a data subject's visit data
      effect: read
      questions:
      - How do I give a visitor a copy of the data tracked about them?
      - Can I export a person's visits for a GDPR access request?
      instructions:
      - text: Export the data subjects for visits {visits}.
        slots:
          visits: query.visits
      - text: Produce an export of the stored data for visits {visits}.
        slots:
          visits: query.visits
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=PrivacyManager.findDataSubjects'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a visitor's data by segment
      effect: read
      questions:
      - How do I locate all visits belonging to a person who made a GDPR request?
      - Can I search visitor data by user ID or IP across my sites?
      instructions:
      - text: Find data subjects matching segment {segment} on site {idSite}.
        slots:
          segment: query.segment
          idSite: query.idSite
      - text: Search site {idSite} for visits where {segment}.
        slots:
          idSite: query.idSite
          segment: query.segment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=PrivacyManager.anonymizeSomeRawData'].get
  update:
    x-apievangelist-phrasing:
      intent: Anonymize past raw visit data
      effect: destructive
      questions:
      - Can I retroactively anonymize IP addresses in data already tracked?
      - How do I scrub location or user ID from old visits?
      instructions:
      - text: Anonymize IPs in raw data for sites {idSites} over {date}.
        slots:
          idSites: query.idSites
          date: query.date
      - text: Schedule anonymization of location and user ID for sites {idSites} in date range {date}.
        slots:
          idSites: query.idSites
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=PrivacyManager.getAvailableVisitColumnsToAnonymize'].get
  update:
    x-apievangelist-phrasing:
      intent: List visit columns that can be anonymized
      effect: read
      questions:
      - Which visit-level fields can I wipe when anonymizing old data?
      - What visit columns are eligible for manual anonymization?
      instructions:
      - text: List visit columns available for anonymization.
      - text: Show which visit log fields I can unset.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=PrivacyManager.getAvailableLinkVisitActionColumnsToAnonymize'].get
  update:
    x-apievangelist-phrasing:
      intent: List action columns that can be anonymized
      effect: read
      questions:
      - Which per-action fields can be cleared when anonymizing data?
      - What action-level columns are eligible for anonymization?
      instructions:
      - text: List action-level columns available for anonymization.
      - text: Show which link-visit-action fields I can unset.
      method: generated
      generated: '2026-10-01'