# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for InCites Document Level Metrics JSON API
  version: 1.0.0
extends: openapi/clarivate-json-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: 5
- target: $.paths['/DocumentLevelMetricsByInstitutionId/json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my institution's document metrics as JSON
      effect: read
      questions:
      - How do I pull document level metrics for all of my institution's papers in a year as JSON?
      - Can I page through institution-wide InCites metrics in JSON?
      instructions:
      - text: 'Get JSON document metrics for {year}: {recordcount} records from {startingrecord}, version {ver}, key {apiKey}.'
        slots:
          year: query.year
          recordcount: query.recordcount
          startingrecord: query.startingrecord
          ver: query.ver
          apiKey: header.X-ApiKey
      - text: Fetch {recordcount} institution metric records in JSON for {year} starting at {startingrecord}, schema {schema}, ver {ver}, key {apiKey}.
        slots:
          recordcount: query.recordcount
          year: query.year
          startingrecord: query.startingrecord
          schema: query.schema
          ver: query.ver
          apiKey: header.X-ApiKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/DocumentLevelMetricsByInstitutionIdRecordCount/json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count my institution's records for a year (JSON)
      effect: read
      questions:
      - How many records are unified to my institution in a given year, in JSON?
      - How do I know how many pages of JSON institution metrics to request?
      instructions:
      - text: Count my institution's records for {year} in JSON with key {apiKey}.
        slots:
          year: query.year
          apiKey: header.X-ApiKey
      - text: Return the JSON record count for year {year} using API key {apiKey}.
        slots:
          year: query.year
          apiKey: header.X-ApiKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/DocumentLevelMetricsByUT/json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get document metrics for a UT (JSON)
      effect: read
      questions:
      - How do I get InCites metrics for one Web of Science accession number in JSON?
      - Can I include ESCI documents when looking up a UT's metrics as JSON?
      instructions:
      - text: Get JSON metrics for UT {UT}, version {ver}, key {apiKey}.
        slots:
          UT: query.UT
          ver: query.ver
          apiKey: header.X-ApiKey
      - text: Fetch JSON document metrics for {UT} with esci {esci}, ver {ver}, key {apiKey}.
        slots:
          UT: query.UT
          esci: query.esci
          ver: query.ver
          apiKey: header.X-ApiKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/CheckValidUTs/json'].get
  update:
    x-apievangelist-phrasing:
      intent: Find invalid UTs in a list (JSON)
      effect: read
      questions:
      - Which accession numbers in my list are not valid UTs, returned as JSON?
      - Can I validate a batch of UTs before requesting JSON metrics?
      instructions:
      - text: Check which of {UT} are invalid, JSON output, key {apiKey}.
        slots:
          UT: query.UT
          apiKey: header.X-ApiKey
      - text: Validate the UT list {UT} as JSON with API key {apiKey}.
        slots:
          UT: query.UT
          apiKey: header.X-ApiKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/InCitesLastUpdated/json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get InCites data update times (JSON)
      effect: read
      questions:
      - When were the InCites and Web of Science datasets last updated, in JSON?
      - How fresh is the InCites data behind the JSON metrics?
      instructions:
      - text: Get the InCites last-updated dates in JSON with key {apiKey}.
        slots:
          apiKey: header.X-ApiKey
      - text: Show when the JSON InCites and WoS indexes were last refreshed, key {apiKey}.
        slots:
          apiKey: header.X-ApiKey
      method: generated
      generated: '2026-10-01'