Coveo Source Logs API — Facets

naftiko: 1.0.0-alpha2
info:
  label: Coveo Source Logs API — Facets
  description: 'Coveo Source Logs API — Facets. 2 operations. Lead operation: Get Facets. Self-contained Naftiko capability
    covering one Coveo business surface.'
  tags:
  - Coveo
  - Source Logs
  - Facets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: source-logs-facets
    baseUri: https://api.cloud.coveo.com/push/v1
    description: Coveo Source Logs API — Facets business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: organizations-organizationId-facets
      path: /organizations/{organizationId}/facets
      operations:
      - name: post
        method: POST
        description: Get Facets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization.
          required: true
        - name: from
          in: query
          type: string
          description: The date and time (in W3C format, see [Date and Time Formats](https://www.w3.org/TR/NOTE-datetime))
            corresponding to the beginning of the range for which to ret
          required: true
        - name: to
          in: query
          type: string
          description: 'The date and time (in W3C format, see [Date and Time Formats](https://www.w3.org/TR/NOTE-datetime))
            corresponding to the end of the range for which to retrieve '
          required: true
        - name: documentId
          in: query
          type: string
          description: The filter string against which to match document `uri` field values. See the `documentIdMatching`
            parameter to set the target kind of filter.<br />For example,
        - name: documentIdMatching
          in: query
          type: string
          description: 'The kind of filter to apply when matching the target `documentId` value against document `uri` field
            values.<br />**Allowed values:**<br />- `EXACT`: the `docum'
        - name: body
          in: body
          type: string
          description: The filters to apply when retrieving the facets.
          required: true
    - name: organizations-organizationId-facetsStats
      path: /organizations/{organizationId}/facetsStats
      operations:
      - name: post
        method: POST
        description: Get Facets with Counts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization.
          required: true
        - name: from
          in: query
          type: string
          description: The date and time (in W3C format, see [Date and Time Formats](https://www.w3.org/TR/NOTE-datetime))
            corresponding to the beginning of the range for which to ret
          required: true
        - name: to
          in: query
          type: string
          description: 'The date and time (in W3C format, see [Date and Time Formats](https://www.w3.org/TR/NOTE-datetime))
            corresponding to the end of the range for which to retrieve '
          required: true
        - name: documentId
          in: query
          type: string
          description: The filter string against which to match document `uri` field values. See the `documentIdMatching`
            parameter to set the target kind of filter.<br />For example,
        - name: documentIdMatching
          in: query
          type: string
          description: 'The kind of filter to apply when matching the target `documentId` value against document `uri` field
            values.<br />**Allowed values:**<br />- `EXACT`: the `docum'
        - name: body
          in: body
          type: string
          description: The filters to apply when retrieving the facets.
          required: true
  exposes:
  - type: rest
    namespace: source-logs-facets-rest
    port: 8080
    description: REST adapter for Coveo Source Logs API — Facets. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/facets
      name: organizations-organizationid-facets
      description: REST surface for organizations-organizationId-facets.
      operations:
      - method: POST
        name: post
        description: Get Facets
        call: source-logs-facets.post
        with:
          organizationId: rest.organizationId
          from: rest.from
          to: rest.to
          documentId: rest.documentId
          documentIdMatching: rest.documentIdMatching
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/facetsstats
      name: organizations-organizationid-facetsstats
      description: REST surface for organizations-organizationId-facetsStats.
      operations:
      - method: POST
        name: post
        description: Get Facets with Counts
        call: source-logs-facets.post
        with:
          organizationId: rest.organizationId
          from: rest.from
          to: rest.to
          documentId: rest.documentId
          documentIdMatching: rest.documentIdMatching
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: source-logs-facets-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Source Logs API — Facets. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-facets
      description: Get Facets
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: source-logs-facets.post
      with:
        organizationId: tools.organizationId
        from: tools.from
        to: tools.to
        documentId: tools.documentId
        documentIdMatching: tools.documentIdMatching
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-facets-counts
      description: Get Facets with Counts
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: source-logs-facets.post
      with:
        organizationId: tools.organizationId
        from: tools.from
        to: tools.to
        documentId: tools.documentId
        documentIdMatching: tools.documentIdMatching
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.