Coveo Search Usage Metrics API — License Metrics

naftiko: 1.0.0-alpha2
info:
  label: Coveo Search Usage Metrics API — License Metrics
  description: 'Coveo Search Usage Metrics API — License Metrics. 6 operations. Lead operation: Lists the Available Metrics
    for Reporting. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Search Usage Metrics
  - License Metrics
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: search-usage-metrics-license-metrics
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Search Usage Metrics API — License Metrics business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-searchusagemetrics-license-all
      path: /rest/organizations/{organizationId}/searchusagemetrics/license/all
      operations:
      - name: listlicensemetrics
        method: GET
        description: Lists the Available Metrics for Reporting
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
    - name: rest-organizations-organizationId-searchusagemetrics-license-assignable
      path: /rest/organizations/{organizationId}/searchusagemetrics/license/assignable
      operations:
      - name: listassignablelicencemetrics
        method: GET
        description: Lists the Available Metrics for Assignment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
    - name: rest-organizations-organizationId-searchusagemetrics-license-daily-metric
      path: /rest/organizations/{organizationId}/searchusagemetrics/license/daily/{metric}
      operations:
      - name: getdailylicensemetrics
        method: GET
        description: Gets Per-Day Values for a Specific License Metric
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: to
          in: query
          type: string
          description: The last day to report for
          required: true
        - name: from
          in: query
          type: string
          description: The first day to report for
          required: true
        - name: metric
          in: path
          type: string
          description: The license metric to report on
          required: true
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
    - name: rest-organizations-organizationId-searchusagemetrics-license-inUse
      path: /rest/organizations/{organizationId}/searchusagemetrics/license/inUse
      operations:
      - name: listinuselicencemetrics
        method: GET
        description: Lists the in-Use Metrics for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
    - name: rest-organizations-organizationId-searchusagemetrics-license-monthly-metric
      path: /rest/organizations/{organizationId}/searchusagemetrics/license/monthly/{metric}
      operations:
      - name: getmonthlylicensemetrics
        method: GET
        description: Gets Per-Day Values for a Specific License Metric
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: slidingWindow
          in: query
          type: string
          description: When appropriate, the size of the sliding window to use, in months. If this parameter is not specified
            the default sliding window for the metric will be used.
        - name: to
          in: query
          type: string
          description: The last month to report for
          required: true
        - name: from
          in: query
          type: string
          description: The first month to report for
          required: true
        - name: metric
          in: path
          type: string
          description: The license metric to report on
          required: true
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
    - name: rest-organizations-organizationId-searchusagemetrics-license-total-metric
      path: /rest/organizations/{organizationId}/searchusagemetrics/license/total/{metric}
      operations:
      - name: gettotallicensemetrics
        method: GET
        description: Gets Total Values for a Specific License Metric Over a Specified Month Range
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: to
          in: query
          type: string
          description: The last month to report for
          required: true
        - name: from
          in: query
          type: string
          description: The first month to report for
          required: true
        - name: metric
          in: path
          type: string
          description: The license metric to report on
          required: true
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
  exposes:
  - type: rest
    namespace: search-usage-metrics-license-metrics-rest
    port: 8080
    description: REST adapter for Coveo Search Usage Metrics API — License Metrics. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/searchusagemetrics/license/all
      name: rest-organizations-organizationid-searchusagemetrics-license-all
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-license-all.
      operations:
      - method: GET
        name: listlicensemetrics
        description: Lists the Available Metrics for Reporting
        call: search-usage-metrics-license-metrics.listlicensemetrics
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchusagemetrics/license/assignable
      name: rest-organizations-organizationid-searchusagemetrics-license-assignable
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-license-assignable.
      operations:
      - method: GET
        name: listassignablelicencemetrics
        description: Lists the Available Metrics for Assignment
        call: search-usage-metrics-license-metrics.listassignablelicencemetrics
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchusagemetrics/license/daily/{metric}
      name: rest-organizations-organizationid-searchusagemetrics-license-daily-metric
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-license-daily-metric.
      operations:
      - method: GET
        name: getdailylicensemetrics
        description: Gets Per-Day Values for a Specific License Metric
        call: search-usage-metrics-license-metrics.getdailylicensemetrics
        with:
          to: rest.to
          from: rest.from
          metric: rest.metric
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchusagemetrics/license/inuse
      name: rest-organizations-organizationid-searchusagemetrics-license-inuse
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-license-inUse.
      operations:
      - method: GET
        name: listinuselicencemetrics
        description: Lists the in-Use Metrics for an Organization
        call: search-usage-metrics-license-metrics.listinuselicencemetrics
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchusagemetrics/license/monthly/{metric}
      name: rest-organizations-organizationid-searchusagemetrics-license-monthly-metric
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-license-monthly-metric.
      operations:
      - method: GET
        name: getmonthlylicensemetrics
        description: Gets Per-Day Values for a Specific License Metric
        call: search-usage-metrics-license-metrics.getmonthlylicensemetrics
        with:
          slidingWindow: rest.slidingWindow
          to: rest.to
          from: rest.from
          metric: rest.metric
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchusagemetrics/license/total/{metric}
      name: rest-organizations-organizationid-searchusagemetrics-license-total-metric
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-license-total-metric.
      operations:
      - method: GET
        name: gettotallicensemetrics
        description: Gets Total Values for a Specific License Metric Over a Specified Month Range
        call: search-usage-metrics-license-metrics.gettotallicensemetrics
        with:
          to: rest.to
          from: rest.from
          metric: rest.metric
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-usage-metrics-license-metrics-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Search Usage Metrics API — License Metrics. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: lists-available-metrics-reporting
      description: Lists the Available Metrics for Reporting
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-usage-metrics-license-metrics.listlicensemetrics
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: lists-available-metrics-assignment
      description: Lists the Available Metrics for Assignment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-usage-metrics-license-metrics.listassignablelicencemetrics
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-per-day-values-specific
      description: Gets Per-Day Values for a Specific License Metric
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-usage-metrics-license-metrics.getdailylicensemetrics
      with:
        to: tools.to
        from: tools.from
        metric: tools.metric
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: lists-use-metrics-organization
      description: Lists the in-Use Metrics for an Organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-usage-metrics-license-metrics.listinuselicencemetrics
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-per-day-values-specific-2
      description: Gets Per-Day Values for a Specific License Metric
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-usage-metrics-license-metrics.getmonthlylicensemetrics
      with:
        slidingWindow: tools.slidingWindow
        to: tools.to
        from: tools.from
        metric: tools.metric
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-total-values-specific-license
      description: Gets Total Values for a Specific License Metric Over a Specified Month Range
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-usage-metrics-license-metrics.gettotallicensemetrics
      with:
        to: tools.to
        from: tools.from
        metric: tools.metric
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.