# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for App Store Connect Metrics API
  version: 1.0.0
extends: openapi/ios-metrics-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: 15
- target: $.paths['/v1/apps/{id}/metrics/betaTesterUsages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get beta tester usage metrics for an app
      effect: read
      questions:
      - How actively are TestFlight testers using my app?
      - Can I break an app's beta tester usage down by tester over a set period?
      instructions:
      - text: Show TestFlight tester usage across all testers of app {id}.
        slots:
          id: path.id
      - text: Get beta tester usage for app {id} over period {period}, grouped by {groupBy}.
        slots:
          id: path.id
          period: query.period
          groupBy: query.groupBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/betaGroups/{id}/metrics/betaTesterUsages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tester usage metrics for a beta group
      effect: read
      questions:
      - How engaged are the testers in one of my TestFlight beta groups?
      - Can I see beta group usage for specific testers only?
      instructions:
      - text: Show tester usage metrics for beta group {id}.
        slots:
          id: path.id
      - text: Get usage in beta group {id} for testers {testers} over {period}.
        slots:
          id: path.id
          testers: query.filter[betaTesters]
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/betaGroups/{id}/metrics/publicLinkUsages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get public link usage for a beta group
      effect: read
      questions:
      - How many people joined my beta through the TestFlight public link?
      - What usage data exists for a beta group's public invite link?
      instructions:
      - text: Show public link usage metrics for beta group {id}.
        slots:
          id: path.id
      - text: Report how beta group {id}'s public TestFlight link is being used.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/betaTesters/{id}/metrics/betaTesterUsages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage metrics for one beta tester
      effect: read
      questions:
      - How much is a specific TestFlight tester using my app?
      - Which app do I need to specify to see one tester's usage?
      instructions:
      - text: Show usage metrics for beta tester {id} in app {app}.
        slots:
          id: path.id
          app: query.filter[apps]
      - text: Get beta tester {id}'s usage of app {app} over {period}.
        slots:
          id: path.id
          app: query.filter[apps]
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/metrics/betaBuildUsages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get beta usage metrics for a build
      effect: read
      questions:
      - How are testers using a particular TestFlight build?
      - Can I see installs and sessions for one beta build?
      instructions:
      - text: Show beta usage metrics for build {id}.
        slots:
          id: path.id
      - text: Report TestFlight usage for build {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/gameCenterDetails/{id}/metrics/classicMatchmakingRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: Get classic matchmaking request metrics
      effect: read
      questions:
      - How many classic Game Center matchmaking requests is my game handling?
      - Can I filter classic matchmaking requests by result, like matched or cancelled?
      instructions:
      - text: Show classic matchmaking request metrics for Game Center detail {id} at {granularity} granularity.
        slots:
          id: path.id
          granularity: query.granularity
      - text: Get classic matchmaking requests for detail {id} with result {result} per {granularity}.
        slots:
          id: path.id
          result: query.filter[result]
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/gameCenterDetails/{id}/metrics/ruleBasedMatchmakingRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: Get rule-based matchmaking request metrics
      effect: read
      questions:
      - How many rule-based matchmaking requests are coming through my Game Center detail?
      - Can I group rule-based matchmaking request counts by result?
      instructions:
      - text: Show rule-based matchmaking request metrics for Game Center detail {id} at {granularity} granularity.
        slots:
          id: path.id
          granularity: query.granularity
      - text: Get rule-based matchmaking requests for detail {id} grouped by {groupBy} per {granularity}.
        slots:
          id: path.id
          groupBy: query.groupBy
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/gameCenterMatchmakingQueues/{id}/metrics/experimentMatchmakingQueueSizes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get experiment queue size metrics
      effect: read
      questions:
      - How large is the experimental matchmaking queue over time?
      - Can I track queue size for a matchmaking experiment separately from the live queue?
      instructions:
      - text: Show experiment matchmaking queue sizes for queue {id} at {granularity} granularity.
        slots:
          id: path.id
          granularity: query.granularity
      - text: Chart the experimental queue size for matchmaking queue {id} per {granularity}.
        slots:
          id: path.id
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/gameCenterMatchmakingQueues/{id}/metrics/experimentMatchmakingRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: Get experiment matchmaking request metrics
      effect: read
      questions:
      - How many matchmaking requests did my experimental queue receive?
      - Can I filter experiment matchmaking requests by Game Center detail?
      instructions:
      - text: Show experiment matchmaking request metrics for queue {id} at {granularity} granularity.
        slots:
          id: path.id
          granularity: query.granularity
      - text: Get experiment matchmaking requests on queue {id} with result {result} per {granularity}.
        slots:
          id: path.id
          result: query.filter[result]
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/gameCenterMatchmakingQueues/{id}/metrics/matchmakingQueueSizes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get matchmaking queue size metrics
      effect: read
      questions:
      - How many players are waiting in my live matchmaking queue over time?
      - What time granularity can I use for matchmaking queue size data?
      instructions:
      - text: Show live queue size metrics for matchmaking queue {id} at {granularity} granularity.
        slots:
          id: path.id
          granularity: query.granularity
      - text: Track the size of matchmaking queue {id} per {granularity}.
        slots:
          id: path.id
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/gameCenterMatchmakingQueues/{id}/metrics/matchmakingRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: Get matchmaking request metrics for a queue
      effect: read
      questions:
      - How many matchmaking requests is my live queue handling?
      - Can I see a queue's matchmaking requests split by result?
      instructions:
      - text: Show matchmaking request metrics for live queue {id} at {granularity} granularity.
        slots:
          id: path.id
          granularity: query.granularity
      - text: Get matchmaking requests on queue {id} for Game Center detail {detail} per {granularity}.
        slots:
          id: path.id
          detail: query.filter[gameCenterDetail]
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/gameCenterMatchmakingQueues/{id}/metrics/matchmakingSessions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get matchmaking session metrics
      effect: read
      questions:
      - How many matchmaking sessions has my queue produced?
      - Can I see session counts for a matchmaking queue by hour or day?
      instructions:
      - text: Show matchmaking session metrics for queue {id} at {granularity} granularity.
        slots:
          id: path.id
          granularity: query.granularity
      - text: Count matchmaking sessions on queue {id} per {granularity}.
        slots:
          id: path.id
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/gameCenterMatchmakingRules/{id}/metrics/matchmakingBooleanRuleResults'].get
  update:
    x-apievangelist-phrasing:
      intent: Get boolean matchmaking rule results
      effect: read
      questions:
      - How often does my boolean matchmaking rule evaluate true versus false?
      - Can I filter a boolean rule's results to one matchmaking queue?
      instructions:
      - text: Show boolean rule results for matchmaking rule {id} at {granularity} granularity.
        slots:
          id: path.id
          granularity: query.granularity
      - text: Get boolean results of rule {id} on queue {queue} per {granularity}.
        slots:
          id: path.id
          queue: query.filter[gameCenterMatchmakingQueue]
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/gameCenterMatchmakingRules/{id}/metrics/matchmakingNumberRuleResults'].get
  update:
    x-apievangelist-phrasing:
      intent: Get numeric matchmaking rule results
      effect: read
      questions:
      - What values is my numeric matchmaking rule producing?
      - Can I see number rule results for a single matchmaking queue?
      instructions:
      - text: Show number rule results for matchmaking rule {id} at {granularity} granularity.
        slots:
          id: path.id
          granularity: query.granularity
      - text: Get numeric results of rule {id} on queue {queue} per {granularity}.
        slots:
          id: path.id
          queue: query.filter[gameCenterMatchmakingQueue]
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/gameCenterMatchmakingRules/{id}/metrics/matchmakingRuleErrors'].get
  update:
    x-apievangelist-phrasing:
      intent: Get matchmaking rule error metrics
      effect: read
      questions:
      - Is my matchmaking rule throwing errors when it evaluates?
      - How many evaluation errors has a matchmaking rule hit per day?
      instructions:
      - text: Show error metrics for matchmaking rule {id} at {granularity} granularity.
        slots:
          id: path.id
          granularity: query.granularity
      - text: Count errors from rule {id} on queue {queue} per {granularity}.
        slots:
          id: path.id
          queue: query.filter[gameCenterMatchmakingQueue]
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'