Coveo Usage Analytics Read API — Groups API - Version 15

naftiko: 1.0.0-alpha2
info:
  label: Coveo Usage Analytics Read API — Groups API - Version 15
  description: 'Coveo Usage Analytics Read API — Groups API - Version 15. 8 operations. Lead operation: Gets All Groups for
    Account.. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Usage Analytics Read
  - Groups API - Version 15
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: usage-analytics-read-groups-api-version-15
    baseUri: https://analytics.cloud.coveo.com/rest/ua
    description: Coveo Usage Analytics Read API — Groups API - Version 15 business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: v15-groups
      path: /v15/groups
      operations:
      - name: getv15groups
        method: GET
        description: Gets All Groups for Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
          required: true
    - name: v15-groups-monitoring-health
      path: /v15/groups/monitoring/health
      operations:
      - name: getv15groupsmonitoringhealth
        method: GET
        description: Health Check for the Groups Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v15-groups-status
      path: /v15/groups/status
      operations:
      - name: getv15groupsstatus
        method: GET
        description: Get the Groups Service Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v15-groups-groupId
      path: /v15/groups/{groupId}
      operations:
      - name: getv15groupsgroupid
        method: GET
        description: Get a Group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: The unique identifier of a group.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v15-groups-groupId-filters
      path: /v15/groups/{groupId}/filters
      operations:
      - name: getv15groupsgroupidfilters
        method: GET
        description: Gets the Data Level Filters That Apply to the Specified Group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: The unique identifier of a group.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
      - name: putv15groupsgroupidfilters
        method: PUT
        description: Set the Filters That Will Be Applied to the Specified Group's Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: The unique identifier of a group.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v15-groups-groupId-reports
      path: /v15/groups/{groupId}/reports
      operations:
      - name: getv15groupsgroupidreports
        method: GET
        description: Gets the Reports That the Specified Group Can Access.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: The unique identifier of a group.
          required: true
        - name: org
          in: query
          type: string
          description: The unique identifier of a user.
        - name: includeConfig
          in: query
          type: boolean
          description: Whether to include the detailed configuration of the report in the response.
      - name: putv15groupsgroupidreports
        method: PUT
        description: Set Which Reports the Specified Group Can Access.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: The unique identifier of a group.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: usage-analytics-read-groups-api-version-15-rest
    port: 8080
    description: REST adapter for Coveo Usage Analytics Read API — Groups API - Version 15. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v15/groups
      name: v15-groups
      description: REST surface for v15-groups.
      operations:
      - method: GET
        name: getv15groups
        description: Gets All Groups for Account.
        call: usage-analytics-read-groups-api-version-15.getv15groups
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/groups/monitoring/health
      name: v15-groups-monitoring-health
      description: REST surface for v15-groups-monitoring-health.
      operations:
      - method: GET
        name: getv15groupsmonitoringhealth
        description: Health Check for the Groups Service
        call: usage-analytics-read-groups-api-version-15.getv15groupsmonitoringhealth
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/groups/status
      name: v15-groups-status
      description: REST surface for v15-groups-status.
      operations:
      - method: GET
        name: getv15groupsstatus
        description: Get the Groups Service Status
        call: usage-analytics-read-groups-api-version-15.getv15groupsstatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/groups/{groupid}
      name: v15-groups-groupid
      description: REST surface for v15-groups-groupId.
      operations:
      - method: GET
        name: getv15groupsgroupid
        description: Get a Group.
        call: usage-analytics-read-groups-api-version-15.getv15groupsgroupid
        with:
          groupId: rest.groupId
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/groups/{groupid}/filters
      name: v15-groups-groupid-filters
      description: REST surface for v15-groups-groupId-filters.
      operations:
      - method: GET
        name: getv15groupsgroupidfilters
        description: Gets the Data Level Filters That Apply to the Specified Group.
        call: usage-analytics-read-groups-api-version-15.getv15groupsgroupidfilters
        with:
          groupId: rest.groupId
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putv15groupsgroupidfilters
        description: Set the Filters That Will Be Applied to the Specified Group's Query
        call: usage-analytics-read-groups-api-version-15.putv15groupsgroupidfilters
        with:
          groupId: rest.groupId
          org: rest.org
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/groups/{groupid}/reports
      name: v15-groups-groupid-reports
      description: REST surface for v15-groups-groupId-reports.
      operations:
      - method: GET
        name: getv15groupsgroupidreports
        description: Gets the Reports That the Specified Group Can Access.
        call: usage-analytics-read-groups-api-version-15.getv15groupsgroupidreports
        with:
          groupId: rest.groupId
          org: rest.org
          includeConfig: rest.includeConfig
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putv15groupsgroupidreports
        description: Set Which Reports the Specified Group Can Access.
        call: usage-analytics-read-groups-api-version-15.putv15groupsgroupidreports
        with:
          groupId: rest.groupId
          org: rest.org
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usage-analytics-read-groups-api-version-15-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Usage Analytics Read API — Groups API - Version 15. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: gets-all-groups-account
      description: Gets All Groups for Account.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-groups-api-version-15.getv15groups
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: health-check-groups-service
      description: Health Check for the Groups Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-groups-api-version-15.getv15groupsmonitoringhealth
      outputParameters:
      - type: object
        mapping: $.
    - name: get-groups-service-status
      description: Get the Groups Service Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-groups-api-version-15.getv15groupsstatus
      outputParameters:
      - type: object
        mapping: $.
    - name: get-group
      description: Get a Group.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-groups-api-version-15.getv15groupsgroupid
      with:
        groupId: tools.groupId
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-data-level-filters-that
      description: Gets the Data Level Filters That Apply to the Specified Group.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-groups-api-version-15.getv15groupsgroupidfilters
      with:
        groupId: tools.groupId
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: set-filters-that-will-be
      description: Set the Filters That Will Be Applied to the Specified Group's Query
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: usage-analytics-read-groups-api-version-15.putv15groupsgroupidfilters
      with:
        groupId: tools.groupId
        org: tools.org
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-reports-that-specified-group
      description: Gets the Reports That the Specified Group Can Access.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-groups-api-version-15.getv15groupsgroupidreports
      with:
        groupId: tools.groupId
        org: tools.org
        includeConfig: tools.includeConfig
      outputParameters:
      - type: object
        mapping: $.
    - name: set-which-reports-specified-group
      description: Set Which Reports the Specified Group Can Access.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: usage-analytics-read-groups-api-version-15.putv15groupsgroupidreports
      with:
        groupId: tools.groupId
        org: tools.org
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.