Coveo Search Usage Metrics API — Raw Metrics

naftiko: 1.0.0-alpha2
info:
  label: Coveo Search Usage Metrics API — Raw Metrics
  description: 'Coveo Search Usage Metrics API — Raw Metrics. 4 operations. Lead operation: Lists the Available Metrics for
    Assignment. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Search Usage Metrics
  - Raw 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-raw-metrics
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Search Usage Metrics API — Raw Metrics business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-searchusagemetrics-raw-all
      path: /rest/organizations/{organizationId}/searchusagemetrics/raw/all
      operations:
      - name: listrawmetrics
        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-raw-monthly
      path: /rest/organizations/{organizationId}/searchusagemetrics/raw/monthly
      operations:
      - name: getrawmetricsformonth
        method: GET
        description: Gets Raw Metric Values for a Specific Month
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: minimumQueries
          in: query
          type: string
          description: The minimum number of queries required for a search hub to be listed
        - name: month
          in: query
          type: string
          description: The month to report for
          required: true
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
    - name: rest-organizations-organizationId-searchusagemetrics-raw-searchhubs-searchHub-da
      path: /rest/organizations/{organizationId}/searchusagemetrics/raw/searchhubs/{searchHub}/daily/{metric}
      operations:
      - name: getdailyrawmetrics
        method: GET
        description: Gets Daily Raw Values for a Specific Search Hub and 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 raw metric to report on
          required: true
        - name: searchHub
          in: path
          type: string
          description: The name of the search hub to report on
          required: true
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
    - name: rest-organizations-organizationId-searchusagemetrics-raw-searchhubs-searchHub-mo
      path: /rest/organizations/{organizationId}/searchusagemetrics/raw/searchhubs/{searchHub}/monthly/{metric}
      operations:
      - name: getmonthlyrawmetrics
        method: GET
        description: Gets Monthly Raw Values for a Specific Search Hub and Metric
        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 raw metric to report on
          required: true
        - name: searchHub
          in: path
          type: string
          description: The name of the search hub to report on
          required: true
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
  exposes:
  - type: rest
    namespace: search-usage-metrics-raw-metrics-rest
    port: 8080
    description: REST adapter for Coveo Search Usage Metrics API — Raw Metrics. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/searchusagemetrics/raw/all
      name: rest-organizations-organizationid-searchusagemetrics-raw-all
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-raw-all.
      operations:
      - method: GET
        name: listrawmetrics
        description: Lists the Available Metrics for Assignment
        call: search-usage-metrics-raw-metrics.listrawmetrics
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchusagemetrics/raw/monthly
      name: rest-organizations-organizationid-searchusagemetrics-raw-monthly
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-raw-monthly.
      operations:
      - method: GET
        name: getrawmetricsformonth
        description: Gets Raw Metric Values for a Specific Month
        call: search-usage-metrics-raw-metrics.getrawmetricsformonth
        with:
          minimumQueries: rest.minimumQueries
          month: rest.month
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchusagemetrics/raw/searchhubs/{searchhub}/daily/{metric}
      name: rest-organizations-organizationid-searchusagemetrics-raw-searchhubs-searchhub-da
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-raw-searchhubs-searchHub-da.
      operations:
      - method: GET
        name: getdailyrawmetrics
        description: Gets Daily Raw Values for a Specific Search Hub and Metric
        call: search-usage-metrics-raw-metrics.getdailyrawmetrics
        with:
          to: rest.to
          from: rest.from
          metric: rest.metric
          searchHub: rest.searchHub
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchusagemetrics/raw/searchhubs/{searchhub}/monthly/{metric}
      name: rest-organizations-organizationid-searchusagemetrics-raw-searchhubs-searchhub-mo
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-raw-searchhubs-searchHub-mo.
      operations:
      - method: GET
        name: getmonthlyrawmetrics
        description: Gets Monthly Raw Values for a Specific Search Hub and Metric
        call: search-usage-metrics-raw-metrics.getmonthlyrawmetrics
        with:
          to: rest.to
          from: rest.from
          metric: rest.metric
          searchHub: rest.searchHub
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-usage-metrics-raw-metrics-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Search Usage Metrics API — Raw Metrics. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: lists-available-metrics-assignment
      description: Lists the Available Metrics for Assignment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-usage-metrics-raw-metrics.listrawmetrics
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-raw-metric-values-specific
      description: Gets Raw Metric Values for a Specific Month
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-usage-metrics-raw-metrics.getrawmetricsformonth
      with:
        minimumQueries: tools.minimumQueries
        month: tools.month
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-daily-raw-values-specific
      description: Gets Daily Raw Values for a Specific Search Hub and Metric
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-usage-metrics-raw-metrics.getdailyrawmetrics
      with:
        to: tools.to
        from: tools.from
        metric: tools.metric
        searchHub: tools.searchHub
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-monthly-raw-values-specific
      description: Gets Monthly Raw Values for a Specific Search Hub and Metric
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-usage-metrics-raw-metrics.getmonthlyrawmetrics
      with:
        to: tools.to
        from: tools.from
        metric: tools.metric
        searchHub: tools.searchHub
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.