How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coveo Data Health API - Version 15 API

The Data Health API - Version 15 API from Coveo — 9 operation(s) for data health api - version 15.

Coveo Data Health API - Version 15 API is one of 152 APIs that Coveo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 34 JSON Schema definitions.

Tagged areas include Data Health API - Version 15. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 9 operations across 9 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://analytics.cloud.coveo.com/rest/ua.

9 operations 9 paths 16 schemas 9 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Coveo Data Health API - Version 15 API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (v8) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 9 GET. Each is listed below with its method, path, parameters, and response codes.

Data Health API - Version 15 9
GET
/v15/datahealth/events/payload
Get the Payload of an Event.
get__v15_datahealth_events_payload 3 params → 200
GET
/v15/datahealth/events/problems
Get Problems About Events
get__v15_datahealth_events_problems 8 params → 200404
GET
/v15/datahealth/criteria/failedInstances
Get Failed Instances for a Data Health Criterion
get__v15_datahealth_criteria_failedInstances 9 params → 200
GET
/v15/datahealth/groups/detail
Get Detailed Information About a Data Health Group
get__v15_datahealth_groups_detail 7 params → 200
GET
/v15/datahealth/groups
Get a Listing of Data Health Groups
get__v15_datahealth_groups 9 params → 200
GET
/v15/datahealth/overview
Get the Data Health Overview
get__v15_datahealth_overview 6 params → 200
GET
/v15/datahealth/status
Get the Data Health Service Status
get__v15_datahealth_status → 200
GET
/v15/datahealth/events
Get Health Information About Events
get__v15_datahealth_events 12 params → 200404
GET
/v15/datahealth/facets
List Facet Values for Event Browser
get__v15_datahealth_facets 11 params → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ListEventsListItemV15 (9 properties), GroupDetailListItemV15 (8 properties), EventProblemsListItemV15 (8 properties), FailedInstancesListItemV15 (5 properties). Each schema is shown below with its type and property counts.

GroupDetailResponseV15
object
A list of criteria detail information.
1 property
GetEventPayloadResponseV15
object
An event's payload.
3 properties
ListFacetValuesResponseV15
object
The values available for the facet
1 property 1 required
FacetValueV15
object
A facet value and the associated count.
2 properties 2 required
GroupListingResponseV15
object
A list of groups.
1 property
ValidationErrorV15
object
A validation error found on an event.
3 properties 3 required
EventProblemsResponseV15
object
A list of events problems.
1 property 1 required
ListEventsResponseV15
object
A list of events.
1 property
ListEventsListItemV15
object
An entry in a list of events.
9 properties 8 required
EventProblemsListItemV15
object
An entry in a list of events problems.
8 properties
GroupListingListItemV15
object
An entry in a list of groups.
5 properties
FailedInstancesResponseV15
object
A list of failed instances.
1 property
FailedInstancesListItemV15
object
A failed instance.
5 properties
OverviewResponseV15
object
An overview of the data health of an organization.
4 properties
GroupDetailListItemV15
object
A list of groups.
8 properties
StatusResponse
object
Service's status information

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-data-health-api-version-15-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
Coveo Administration API - Version 15 API
Coveo Advanced Model Configurations API
Coveo Agent Configuration API API
Coveo Agent Orchestration API API
Coveo Analysis V3 API
Coveo Analytics API - Version 14 API
Coveo Analytics API - Version 15 API
Coveo Answer API
Coveo Api Keys API
Coveo Atlassian Connect App API
Coveo Badges API
Where this information came from

This is an independent, third-party profile of Coveo Data Health API - Version 15 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.