Coveo Organization API — Organization Endpoints Monitoring

naftiko: 1.0.0-alpha2
info:
  label: Coveo Organization API — Organization Endpoints Monitoring
  description: 'Coveo Organization API — Organization Endpoints Monitoring. 4 operations. Lead operation: Get the Customer
    Endpoint Usage Status for an Organization.. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Organization
  - Organization Endpoints Monitoring
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: organization-organization-endpoints-monitoring
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Organization API — Organization Endpoints Monitoring business capability. Self-contained, no shared
      references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-monitoring-global-organizations-organizationId-endpoints-readiness
      path: /rest/monitoring/global/organizations/{organizationId}/endpoints/readiness
      operations:
      - name: getcustomerendpointusagestatus
        method: GET
        description: Get the Customer Endpoint Usage Status for an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: numberOfDaysToInclude
          in: query
          type: integer
    - name: rest-monitoring-global-organizations-organizationId-endpoints-usage
      path: /rest/monitoring/global/organizations/{organizationId}/endpoints/usage
      operations:
      - name: getendpointusage
        method: GET
        description: Get the Endpoints Usage for an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: numberOfDaysToInclude
          in: query
          type: integer
    - name: rest-monitoring-global-organizations-organizationId-search-hubs-usage
      path: /rest/monitoring/global/organizations/{organizationId}/search-hubs/usage
      operations:
      - name: getsearchhubusage
        method: GET
        description: Get the Search Hubs Usage for an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: hostname
          in: query
          type: string
          required: true
        - name: numberOfDaysToInclude
          in: query
          type: integer
        - name: page
          in: query
          type: integer
        - name: perPage
          in: query
          type: integer
    - name: rest-monitoring-global-organizations-organizationId-usage-regions
      path: /rest/monitoring/global/organizations/{organizationId}/usage/regions
      operations:
      - name: getregionusage
        method: GET
        description: Get Usage Per Region for an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: numberOfDaysToInclude
          in: query
          type: integer
  exposes:
  - type: rest
    namespace: organization-organization-endpoints-monitoring-rest
    port: 8080
    description: REST adapter for Coveo Organization API — Organization Endpoints Monitoring. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/monitoring/global/organizations/{organizationid}/endpoints/readiness
      name: rest-monitoring-global-organizations-organizationid-endpoints-readiness
      description: REST surface for rest-monitoring-global-organizations-organizationId-endpoints-readiness.
      operations:
      - method: GET
        name: getcustomerendpointusagestatus
        description: Get the Customer Endpoint Usage Status for an Organization.
        call: organization-organization-endpoints-monitoring.getcustomerendpointusagestatus
        with:
          organizationId: rest.organizationId
          numberOfDaysToInclude: rest.numberOfDaysToInclude
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/monitoring/global/organizations/{organizationid}/endpoints/usage
      name: rest-monitoring-global-organizations-organizationid-endpoints-usage
      description: REST surface for rest-monitoring-global-organizations-organizationId-endpoints-usage.
      operations:
      - method: GET
        name: getendpointusage
        description: Get the Endpoints Usage for an Organization.
        call: organization-organization-endpoints-monitoring.getendpointusage
        with:
          organizationId: rest.organizationId
          numberOfDaysToInclude: rest.numberOfDaysToInclude
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/monitoring/global/organizations/{organizationid}/search-hubs/usage
      name: rest-monitoring-global-organizations-organizationid-search-hubs-usage
      description: REST surface for rest-monitoring-global-organizations-organizationId-search-hubs-usage.
      operations:
      - method: GET
        name: getsearchhubusage
        description: Get the Search Hubs Usage for an Organization.
        call: organization-organization-endpoints-monitoring.getsearchhubusage
        with:
          organizationId: rest.organizationId
          hostname: rest.hostname
          numberOfDaysToInclude: rest.numberOfDaysToInclude
          page: rest.page
          perPage: rest.perPage
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/monitoring/global/organizations/{organizationid}/usage/regions
      name: rest-monitoring-global-organizations-organizationid-usage-regions
      description: REST surface for rest-monitoring-global-organizations-organizationId-usage-regions.
      operations:
      - method: GET
        name: getregionusage
        description: Get Usage Per Region for an Organization.
        call: organization-organization-endpoints-monitoring.getregionusage
        with:
          organizationId: rest.organizationId
          numberOfDaysToInclude: rest.numberOfDaysToInclude
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: organization-organization-endpoints-monitoring-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Organization API — Organization Endpoints Monitoring. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-customer-endpoint-usage-status
      description: Get the Customer Endpoint Usage Status for an Organization.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: organization-organization-endpoints-monitoring.getcustomerendpointusagestatus
      with:
        organizationId: tools.organizationId
        numberOfDaysToInclude: tools.numberOfDaysToInclude
      outputParameters:
      - type: object
        mapping: $.
    - name: get-endpoints-usage-organization
      description: Get the Endpoints Usage for an Organization.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: organization-organization-endpoints-monitoring.getendpointusage
      with:
        organizationId: tools.organizationId
        numberOfDaysToInclude: tools.numberOfDaysToInclude
      outputParameters:
      - type: object
        mapping: $.
    - name: get-search-hubs-usage-organization
      description: Get the Search Hubs Usage for an Organization.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: organization-organization-endpoints-monitoring.getsearchhubusage
      with:
        organizationId: tools.organizationId
        hostname: tools.hostname
        numberOfDaysToInclude: tools.numberOfDaysToInclude
        page: tools.page
        perPage: tools.perPage
      outputParameters:
      - type: object
        mapping: $.
    - name: get-usage-per-region-organization
      description: Get Usage Per Region for an Organization.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: organization-organization-endpoints-monitoring.getregionusage
      with:
        organizationId: tools.organizationId
        numberOfDaysToInclude: tools.numberOfDaysToInclude
      outputParameters:
      - type: object
        mapping: $.