Coveo Source Logs API — Logs

naftiko: 1.0.0-alpha2
info:
  label: Coveo Source Logs API — Logs
  description: 'Coveo Source Logs API — Logs. 2 operations. Lead operation: Get Specified Source Document Logs. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Source Logs
  - Logs
  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-logs
    baseUri: https://api.cloud.coveo.com/push/v1
    description: Coveo Source Logs API — Logs business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: organizations-organizationId
      path: /organizations/{organizationId}
      operations:
      - name: get
        method: GET
        description: Get Specified Source Document Logs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: sourceId
          in: query
          type: string
        - name: documentId
          in: query
          type: string
        - name: tasks
          in: query
          type: string
        - name: operations
          in: query
          type: string
        - name: results
          in: query
          type: string
        - name: from
          in: query
          type: string
          required: true
        - name: to
          in: query
          type: string
          required: true
        - name: page
          in: query
          type: string
        - name: perPage
          in: query
          type: string
      - name: post
        method: POST
        description: Get Indexing Pipeline Logs
        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: page
          in: query
          type: string
          description: The 0-based index number of the page to retrieve.
        - name: perPage
          in: query
          type: string
          description: The number of indexing pipeline log entries to retrieve per page.
        - name: body
          in: body
          type: string
          description: The filters to apply when retrieving the indexing pipeline log entries.
          required: true
  exposes:
  - type: rest
    namespace: source-logs-logs-rest
    port: 8080
    description: REST adapter for Coveo Source Logs API — Logs. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{organizationid}
      name: organizations-organizationid
      description: REST surface for organizations-organizationId.
      operations:
      - method: GET
        name: get
        description: Get Specified Source Document Logs
        call: source-logs-logs.get
        with:
          organizationId: rest.organizationId
          sourceId: rest.sourceId
          documentId: rest.documentId
          tasks: rest.tasks
          operations: rest.operations
          results: rest.results
          from: rest.from
          to: rest.to
          page: rest.page
          perPage: rest.perPage
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Get Indexing Pipeline Logs
        call: source-logs-logs.post
        with:
          organizationId: rest.organizationId
          from: rest.from
          to: rest.to
          documentId: rest.documentId
          documentIdMatching: rest.documentIdMatching
          page: rest.page
          perPage: rest.perPage
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: source-logs-logs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Source Logs API — Logs. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-specified-source-document-logs
      description: Get Specified Source Document Logs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: source-logs-logs.get
      with:
        organizationId: tools.organizationId
        sourceId: tools.sourceId
        documentId: tools.documentId
        tasks: tools.tasks
        operations: tools.operations
        results: tools.results
        from: tools.from
        to: tools.to
        page: tools.page
        perPage: tools.perPage
      outputParameters:
      - type: object
        mapping: $.
    - name: get-indexing-pipeline-logs
      description: Get Indexing Pipeline Logs
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: source-logs-logs.post
      with:
        organizationId: tools.organizationId
        from: tools.from
        to: tools.to
        documentId: tools.documentId
        documentIdMatching: tools.documentIdMatching
        page: tools.page
        perPage: tools.perPage
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.