Coveo Search Usage Metrics API — Query Logs

naftiko: 1.0.0-alpha2
info:
  label: Coveo Search Usage Metrics API — Query Logs
  description: 'Coveo Search Usage Metrics API — Query Logs. 2 operations. Lead operation: Retrieves the Query Logs for a
    Search Hub. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Search Usage Metrics
  - Query Logs
  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-query-logs
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Search Usage Metrics API — Query Logs business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-searchusagemetrics-hubs-logs
      path: /rest/organizations/{organizationId}/searchusagemetrics/hubs/logs
      operations:
      - name: getquerylogs
        method: POST
        description: Retrieves the Query Logs for a Search Hub
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: to
          in: query
          type: string
          description: The last day to retrieve
          required: true
        - name: from
          in: query
          type: string
          description: The first day to retrieve
          required: true
        - name: hubName
          in: query
          type: string
          description: The search hub name
          required: true
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
    - name: rest-organizations-organizationId-searchusagemetrics-hubs-hubName-logs
      path: /rest/organizations/{organizationId}/searchusagemetrics/hubs/{hubName}/logs
      operations:
      - name: getquerylogswithpathparam
        method: POST
        description: Retrieves the Query Logs for a Search Hub
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
        - name: hubName
          in: path
          type: string
          description: The search hub name
          required: true
        - name: from
          in: query
          type: string
          description: The first day to retrieve
          required: true
        - name: to
          in: query
          type: string
          description: The last day to retrieve
          required: true
  exposes:
  - type: rest
    namespace: search-usage-metrics-query-logs-rest
    port: 8080
    description: REST adapter for Coveo Search Usage Metrics API — Query Logs. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/searchusagemetrics/hubs/logs
      name: rest-organizations-organizationid-searchusagemetrics-hubs-logs
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-hubs-logs.
      operations:
      - method: POST
        name: getquerylogs
        description: Retrieves the Query Logs for a Search Hub
        call: search-usage-metrics-query-logs.getquerylogs
        with:
          to: rest.to
          from: rest.from
          hubName: rest.hubName
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchusagemetrics/hubs/{hubname}/logs
      name: rest-organizations-organizationid-searchusagemetrics-hubs-hubname-logs
      description: REST surface for rest-organizations-organizationId-searchusagemetrics-hubs-hubName-logs.
      operations:
      - method: POST
        name: getquerylogswithpathparam
        description: Retrieves the Query Logs for a Search Hub
        call: search-usage-metrics-query-logs.getquerylogswithpathparam
        with:
          organizationId: rest.organizationId
          hubName: rest.hubName
          from: rest.from
          to: rest.to
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-usage-metrics-query-logs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Search Usage Metrics API — Query Logs. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: retrieves-query-logs-search-hub
      description: Retrieves the Query Logs for a Search Hub
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-usage-metrics-query-logs.getquerylogs
      with:
        to: tools.to
        from: tools.from
        hubName: tools.hubName
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-query-logs-search-hub-2
      description: Retrieves the Query Logs for a Search Hub
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-usage-metrics-query-logs.getquerylogswithpathparam
      with:
        organizationId: tools.organizationId
        hubName: tools.hubName
        from: tools.from
        to: tools.to
      outputParameters:
      - type: object
        mapping: $.