# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Web of Science SUSHI COUNTER5 Reports API
  version: 1.0.0
extends: openapi/clarivate-reports-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported COUNTER usage reports
      effect: read
      questions:
      - Which COUNTER R5 reports can I harvest from Web of Science?
      - How do I see the list of usage reports available for my customer ID?
      instructions:
      - text: List the usage reports available for customer {customer_id}.
        slots:
          customer_id: query.customer_id
      - text: Show supported COUNTER reports for customer {customer_id} matching {search}.
        slots:
          customer_id: query.customer_id
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/pr'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Platform Master Report (PR)
      effect: read
      questions:
      - How do I pull the customizable COUNTER platform usage master report?
      - Can I choose metric types and monthly granularity for platform usage?
      instructions:
      - text: Get the PR platform master report for customer {customer_id}, requestor {requestor_id}, from {begin} to {end}.
        slots:
          customer_id: query.customer_id
          requestor_id: query.requestor_id
          begin: query.begin_date
          end: query.end_date
      - text: Pull PR platform usage for {customer_id} ({requestor_id}) {begin} to {end} with metric {metric_type}.
        slots:
          customer_id: query.customer_id
          requestor_id: query.requestor_id
          begin: query.begin_date
          end: query.end_date
          metric_type: query.metric_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/pr_p1'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the PR_P1 platform usage standard view
      effect: read
      questions:
      - Where do I get the standard PR_P1 view of overall platform usage by metric type?
      - Can I get platform usage without configuring filters or attributes?
      instructions:
      - text: Get the PR_P1 standard view for customer {customer_id}, requestor {requestor_id}, {begin} to {end}.
        slots:
          customer_id: query.customer_id
          requestor_id: query.requestor_id
          begin: query.begin_date
          end: query.end_date
      - text: Fetch the PR_P1 report of overall platform usage for {customer_id} as {requestor_id} between {begin} and {end}.
        slots:
          customer_id: query.customer_id
          requestor_id: query.requestor_id
          begin: query.begin_date
          end: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/dr'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Database Master Report (DR)
      effect: read
      questions:
      - How do I get a customizable COUNTER report of usage by database?
      - Can I filter database usage by metric type and granularity?
      instructions:
      - text: Get the DR database master report for customer {customer_id}, requestor {requestor_id}, {begin} to {end}.
        slots:
          customer_id: query.customer_id
          requestor_id: query.requestor_id
          begin: query.begin_date
          end: query.end_date
      - text: Pull DR usage by database for {customer_id} ({requestor_id}) {begin} to {end} at {granularity} granularity.
        slots:
          customer_id: query.customer_id
          requestor_id: query.requestor_id
          begin: query.begin_date
          end: query.end_date
          granularity: query.granularity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/dr_d1'].get
  update:
    x-apievangelist-phrasing:
      intent: Get database search and item usage (DR_D1)
      effect: read
      questions:
      - Which report shows searches and item requests per database for evaluating a database?
      - How do I get the DR_D1 database search and item usage view?
      instructions:
      - text: Get the DR_D1 search and item usage report for customer {customer_id}, requestor {requestor_id}, {begin} to {end}.
        slots:
          customer_id: query.customer_id
          requestor_id: query.requestor_id
          begin: query.begin_date
          end: query.end_date
      - text: Show database searches and requests (DR_D1) for {customer_id} as {requestor_id} from {begin} until {end}.
        slots:
          customer_id: query.customer_id
          requestor_id: query.requestor_id
          begin: query.begin_date
          end: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/dr_d2'].get
  update:
    x-apievangelist-phrasing:
      intent: Get database access denied report (DR_D2)
      effect: read
      questions:
      - How do I see when users were turned away because simultaneous-use licenses were exceeded?
      - Which report shows database access denials for my institution?
      instructions:
      - text: Get the DR_D2 access denied report for customer {customer_id}, requestor {requestor_id}, {begin} to {end}.
        slots:
          customer_id: query.customer_id
          requestor_id: query.requestor_id
          begin: query.begin_date
          end: query.end_date
      - text: Show denied database access (DR_D2) for {customer_id} as {requestor_id} between {begin} and {end}.
        slots:
          customer_id: query.customer_id
          requestor_id: query.requestor_id
          begin: query.begin_date
          end: query.end_date
      method: generated
      generated: '2026-09-26'