Coveo API Overview
Coveo is a native cloud SaaS/PaaS solution that provides a unified and secure way to query content across many enterprise systems. The platform relies on usage analytics data to yield Coveo Machine Learning (Coveo ML)-powered recommendations. Coveo embraces the concepts of micro-services and scalability, allowing users to expand their search solution as their business grows.
The following diagram provides a visual overview of the main interactions between the REST API services and a Coveo organization.
Coveo REST APIs
|API name||Usage||Reference documentation||Guide|
|Activity||Access the activity information of a Coveo organization.||N/A|
|Catalog||Manage catalogs in a Coveo organization.||N/A|
|Extension||Manage and test pre and post conversion indexing pipeline extensions.|
|Field||Manage fields in an index.|
|Index||Access the permission models of indexed items.|
|Machine Learning||Manage Coveo ML models in an organization.|
|Notification||Manage and test activity notification subscriptions for a Coveo organization.|
|Push||Push items and their respective permission models to a Push source, and push security identities to a security identity provider (as opposed to pulling content into a "standard" source using Coveo crawlers).|
|Schema||Manage Coveo for Salesforce schemas.||N/A|
|Search Pages||Manage hosted search pages in a Coveo organization.||N/A|
|Search Usage Metrics||Review search consumption data.||N/A|
|Source||Manage sources and their related field mappings and pre- and post- conversion Coveo indexing pipeline extensions.|
|Source Logs||Access the Coveo indexing pipeline logs of a source.||N/A|
|Usage Analytics Read||Access usage analytics data (statistics, reports, dimensions, metrics, etc.).|
|Usage Analytics Write||Record Coveo Usage Analytics (Coveo UA) events (click, search, view, or custom events).|
Generated Swagger UI Documentation Site
You can visualize the API reference documentation and test API calls using the generated Swagger UI Coveo API reference documentation site (see Coveo API).