Coveo Usage Analytics Read API — Data Health API - Version 15

naftiko: 1.0.0-alpha2
info:
  label: Coveo Usage Analytics Read API — Data Health API - Version 15
  description: 'Coveo Usage Analytics Read API — Data Health API - Version 15. 9 operations. Lead operation: Get Failed Instances
    for a Data Health Criterion. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Usage Analytics Read
  - Data Health 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-data-health-api-version-15
    baseUri: https://analytics.cloud.coveo.com/rest/ua
    description: Coveo Usage Analytics Read API — Data Health API - Version 15 business capability. Self-contained, no shared
      references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: v15-datahealth-criteria-failedInstances
      path: /v15/datahealth/criteria/failedInstances
      operations:
      - name: getv15datahealthcriteriafailedinstances
        method: GET
        description: Get Failed Instances for a Data Health Criterion
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: string
          description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: to
          in: query
          type: string
          description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: criterionId
          in: query
          type: string
          description: The data health criterion for which the failed instances should be returned.
          required: true
        - name: group
          in: query
          type: string
          description: The group for which data health information should be returned.
          required: true
        - name: scopeValue
          in: query
          type: string
          description: The value of the criterion scope for which failed instances should be returned. For example, if the
            scope of a rule is 'EVENT', the scope value could be 'Click'
        - name: trackingId
          in: query
          type: array
          description: The tracking IDs for which the results should be returned.
        - name: page
          in: query
          type: integer
          description: The response's page to access, starting at 0.
        - name: perPage
          in: query
          type: integer
          description: The number of results to include in a page.
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v15-datahealth-events
      path: /v15/datahealth/events
      operations:
      - name: getv15datahealthevents
        method: GET
        description: Get Health Information About Events
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: string
          description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: to
          in: query
          type: string
          description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: clientId
          in: query
          type: array
          description: A set of client IDs for which the events will be returned.
        - name: visitId
          in: query
          type: array
          description: A set of visit IDs for which the events will be returned.
        - name: eventSource
          in: query
          type: array
          description: A set of event sources for which the events will be returned.
        - name: eventType
          in: query
          type: array
          description: A set of event types for which the events will be returned.
        - name: searchHub
          in: query
          type: array
          description: A set of search hubs for which the events will be returned.
        - name: trackingId
          in: query
          type: array
          description: The tracking IDs for which the results should be returned.
        - name: healthStatus
          in: query
          type: string
          description: A health status for which the events will be returned.
        - name: page
          in: query
          type: integer
          description: The response's page to access, starting at 0.
        - name: perPage
          in: query
          type: integer
          description: The number of results to include in a page.
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v15-datahealth-events-payload
      path: /v15/datahealth/events/payload
      operations:
      - name: getv15datahealtheventspayload
        method: GET
        description: Get the Payload of an Event.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timestamp
          in: query
          type: string
          description: The timestamp of the event. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: eventId
          in: query
          type: string
          description: The id of the event for which to return information.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v15-datahealth-events-problems
      path: /v15/datahealth/events/problems
      operations:
      - name: getv15datahealtheventsproblems
        method: GET
        description: Get Problems About Events
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: string
          description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: to
          in: query
          type: string
          description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: eventType
          in: query
          type: array
          description: A set of event types for which the events will be returned.
        - name: searchHub
          in: query
          type: array
          description: A set of search hubs for which the events will be returned.
        - name: trackingId
          in: query
          type: array
          description: The tracking IDs for which the results should be returned.
        - name: page
          in: query
          type: integer
          description: The response's page to access, starting at 0.
        - name: perPage
          in: query
          type: integer
          description: The number of results to include in a page.
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v15-datahealth-facets
      path: /v15/datahealth/facets
      operations:
      - name: getv15datahealthfacets
        method: GET
        description: List Facet Values for Event Browser
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: facet
          in: query
          type: string
          description: The facet for which the values should be listed
          required: true
        - name: from
          in: query
          type: string
          description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: to
          in: query
          type: string
          description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: clientId
          in: query
          type: array
          description: A set of client IDs for which the events will be returned.
        - name: visitId
          in: query
          type: array
          description: A set of visit IDs for which the events will be returned.
        - name: eventSource
          in: query
          type: array
          description: A set of event sources for which the events will be returned.
        - name: eventType
          in: query
          type: array
          description: A set of event types for which the events will be returned.
        - name: searchHub
          in: query
          type: array
          description: A set of search hubs for which the events will be returned.
        - name: trackingId
          in: query
          type: array
          description: The tracking IDs for which the results should be returned.
        - name: healthStatus
          in: query
          type: string
          description: A health status for which the events will be returned.
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v15-datahealth-groups
      path: /v15/datahealth/groups
      operations:
      - name: getv15datahealthgroups
        method: GET
        description: Get a Listing of Data Health Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: string
          description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: to
          in: query
          type: string
          description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: category
          in: query
          type: array
          description: The categories of rules for which data health should be displayed.
        - name: feature
          in: query
          type: array
          description: The feature for which data health should be computed.
        - name: trackingId
          in: query
          type: array
          description: The tracking IDs for which the results should be returned.
        - name: page
          in: query
          type: integer
          description: The response's page to access, starting at 0.
        - name: perPage
          in: query
          type: integer
          description: The number of results to include in a page.
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: showEmptyGroups
          in: query
          type: boolean
          description: Whether or not groups with zero event validated should be shown
    - name: v15-datahealth-groups-detail
      path: /v15/datahealth/groups/detail
      operations:
      - name: getv15datahealthgroupsdetail
        method: GET
        description: Get Detailed Information About a Data Health Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: string
          description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: to
          in: query
          type: string
          description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: group
          in: query
          type: string
          description: The group for which data health information should be returned.
          required: true
        - name: category
          in: query
          type: array
          description: The categories of rules for which data health should be displayed.
        - name: feature
          in: query
          type: array
          description: The feature for which data health should be computed.
        - name: trackingId
          in: query
          type: array
          description: The tracking IDs for which the results should be returned.
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v15-datahealth-overview
      path: /v15/datahealth/overview
      operations:
      - name: getv15datahealthoverview
        method: GET
        description: Get the Data Health Overview
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: string
          description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: to
          in: query
          type: string
          description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: category
          in: query
          type: array
          description: The categories of rules for which data health should be displayed.
        - name: feature
          in: query
          type: array
          description: The feature for which data health should be computed.
        - name: trackingId
          in: query
          type: array
          description: The tracking IDs for which the results should be returned.
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v15-datahealth-status
      path: /v15/datahealth/status
      operations:
      - name: getv15datahealthstatus
        method: GET
        description: Get the Data Health Service Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: usage-analytics-read-data-health-api-version-15-rest
    port: 8080
    description: REST adapter for Coveo Usage Analytics Read API — Data Health API - Version 15. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v15/datahealth/criteria/failedinstances
      name: v15-datahealth-criteria-failedinstances
      description: REST surface for v15-datahealth-criteria-failedInstances.
      operations:
      - method: GET
        name: getv15datahealthcriteriafailedinstances
        description: Get Failed Instances for a Data Health Criterion
        call: usage-analytics-read-data-health-api-version-15.getv15datahealthcriteriafailedinstances
        with:
          from: rest.from
          to: rest.to
          criterionId: rest.criterionId
          group: rest.group
          scopeValue: rest.scopeValue
          trackingId: rest.trackingId
          page: rest.page
          perPage: rest.perPage
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/datahealth/events
      name: v15-datahealth-events
      description: REST surface for v15-datahealth-events.
      operations:
      - method: GET
        name: getv15datahealthevents
        description: Get Health Information About Events
        call: usage-analytics-read-data-health-api-version-15.getv15datahealthevents
        with:
          from: rest.from
          to: rest.to
          clientId: rest.clientId
          visitId: rest.visitId
          eventSource: rest.eventSource
          eventType: rest.eventType
          searchHub: rest.searchHub
          trackingId: rest.trackingId
          healthStatus: rest.healthStatus
          page: rest.page
          perPage: rest.perPage
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/datahealth/events/payload
      name: v15-datahealth-events-payload
      description: REST surface for v15-datahealth-events-payload.
      operations:
      - method: GET
        name: getv15datahealtheventspayload
        description: Get the Payload of an Event.
        call: usage-analytics-read-data-health-api-version-15.getv15datahealtheventspayload
        with:
          timestamp: rest.timestamp
          eventId: rest.eventId
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/datahealth/events/problems
      name: v15-datahealth-events-problems
      description: REST surface for v15-datahealth-events-problems.
      operations:
      - method: GET
        name: getv15datahealtheventsproblems
        description: Get Problems About Events
        call: usage-analytics-read-data-health-api-version-15.getv15datahealtheventsproblems
        with:
          from: rest.from
          to: rest.to
          eventType: rest.eventType
          searchHub: rest.searchHub
          trackingId: rest.trackingId
          page: rest.page
          perPage: rest.perPage
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/datahealth/facets
      name: v15-datahealth-facets
      description: REST surface for v15-datahealth-facets.
      operations:
      - method: GET
        name: getv15datahealthfacets
        description: List Facet Values for Event Browser
        call: usage-analytics-read-data-health-api-version-15.getv15datahealthfacets
        with:
          facet: rest.facet
          from: rest.from
          to: rest.to
          clientId: rest.clientId
          visitId: rest.visitId
          eventSource: rest.eventSource
          eventType: rest.eventType
          searchHub: rest.searchHub
          trackingId: rest.trackingId
          healthStatus: rest.healthStatus
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/datahealth/groups
      name: v15-datahealth-groups
      description: REST surface for v15-datahealth-groups.
      operations:
      - method: GET
        name: getv15datahealthgroups
        description: Get a Listing of Data Health Groups
        call: usage-analytics-read-data-health-api-version-15.getv15datahealthgroups
        with:
          from: rest.from
          to: rest.to
          category: rest.category
          feature: rest.feature
          trackingId: rest.trackingId
          page: rest.page
          perPage: rest.perPage
          org: rest.org
          showEmptyGroups: rest.showEmptyGroups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/datahealth/groups/detail
      name: v15-datahealth-groups-detail
      description: REST surface for v15-datahealth-groups-detail.
      operations:
      - method: GET
        name: getv15datahealthgroupsdetail
        description: Get Detailed Information About a Data Health Group
        call: usage-analytics-read-data-health-api-version-15.getv15datahealthgroupsdetail
        with:
          from: rest.from
          to: rest.to
          group: rest.group
          category: rest.category
          feature: rest.feature
          trackingId: rest.trackingId
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/datahealth/overview
      name: v15-datahealth-overview
      description: REST surface for v15-datahealth-overview.
      operations:
      - method: GET
        name: getv15datahealthoverview
        description: Get the Data Health Overview
        call: usage-analytics-read-data-health-api-version-15.getv15datahealthoverview
        with:
          from: rest.from
          to: rest.to
          category: rest.category
          feature: rest.feature
          trackingId: rest.trackingId
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/datahealth/status
      name: v15-datahealth-status
      description: REST surface for v15-datahealth-status.
      operations:
      - method: GET
        name: getv15datahealthstatus
        description: Get the Data Health Service Status
        call: usage-analytics-read-data-health-api-version-15.getv15datahealthstatus
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usage-analytics-read-data-health-api-version-15-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Usage Analytics Read API — Data Health API - Version 15. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-failed-instances-data-health
      description: Get Failed Instances for a Data Health Criterion
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-data-health-api-version-15.getv15datahealthcriteriafailedinstances
      with:
        from: tools.from
        to: tools.to
        criterionId: tools.criterionId
        group: tools.group
        scopeValue: tools.scopeValue
        trackingId: tools.trackingId
        page: tools.page
        perPage: tools.perPage
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-health-information-about-events
      description: Get Health Information About Events
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-data-health-api-version-15.getv15datahealthevents
      with:
        from: tools.from
        to: tools.to
        clientId: tools.clientId
        visitId: tools.visitId
        eventSource: tools.eventSource
        eventType: tools.eventType
        searchHub: tools.searchHub
        trackingId: tools.trackingId
        healthStatus: tools.healthStatus
        page: tools.page
        perPage: tools.perPage
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-payload-event
      description: Get the Payload of an Event.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-data-health-api-version-15.getv15datahealtheventspayload
      with:
        timestamp: tools.timestamp
        eventId: tools.eventId
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-problems-about-events
      description: Get Problems About Events
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-data-health-api-version-15.getv15datahealtheventsproblems
      with:
        from: tools.from
        to: tools.to
        eventType: tools.eventType
        searchHub: tools.searchHub
        trackingId: tools.trackingId
        page: tools.page
        perPage: tools.perPage
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: list-facet-values-event-browser
      description: List Facet Values for Event Browser
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-data-health-api-version-15.getv15datahealthfacets
      with:
        facet: tools.facet
        from: tools.from
        to: tools.to
        clientId: tools.clientId
        visitId: tools.visitId
        eventSource: tools.eventSource
        eventType: tools.eventType
        searchHub: tools.searchHub
        trackingId: tools.trackingId
        healthStatus: tools.healthStatus
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-listing-data-health-groups
      description: Get a Listing of Data Health Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-data-health-api-version-15.getv15datahealthgroups
      with:
        from: tools.from
        to: tools.to
        category: tools.category
        feature: tools.feature
        trackingId: tools.trackingId
        page: tools.page
        perPage: tools.perPage
        org: tools.org
        showEmptyGroups: tools.showEmptyGroups
      outputParameters:
      - type: object
        mapping: $.
    - name: get-detailed-information-about-data
      description: Get Detailed Information About a Data Health Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-data-health-api-version-15.getv15datahealthgroupsdetail
      with:
        from: tools.from
        to: tools.to
        group: tools.group
        category: tools.category
        feature: tools.feature
        trackingId: tools.trackingId
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-data-health-overview
      description: Get the Data Health Overview
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-data-health-api-version-15.getv15datahealthoverview
      with:
        from: tools.from
        to: tools.to
        category: tools.category
        feature: tools.feature
        trackingId: tools.trackingId
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-data-health-service-status
      description: Get the Data Health Service Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-data-health-api-version-15.getv15datahealthstatus
      outputParameters:
      - type: object
        mapping: $.