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 (UA) 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.

As such, Coveo exposes REST APIs which you can use to achieve anything you could do from the Coveo Administration Console or from a Coveo JavaScript Search Framework search interface.

The following diagram provides a visual overview of the main interactions between the REST API services and a Coveo organization.

API overview
Tip

You may want to use the Official Coveo APIs JavaScript Client to query Coveo APIs.

Coveo REST APIs

API name Usage Reference documentation Guide

Activity

Access the activity information of a Coveo organization.

code

N/A

Authorization Server

  • Manage SAML security identity providers for a Coveo organization.

  • Manage groups, members, and API keys in a Coveo organization.

code

guide

Catalog

Manage catalogs in a Coveo organization.

code

N/A

Extension

Manage and test pre-conversion and post-conversion indexing pipeline extensions.

code

guide

Field

Manage fields in an index.

code

guide

Index

Access the permission models of indexed items.

code

guide

Machine Learning

Manage Coveo ML models in an organization.

code

guide

Notification

Manage and test activity notification subscriptions for a Coveo organization.

code

guide

Platform

  • Create, update, or delete a Coveo organization.

  • Access a Coveo organization status, login activity, license, and limit information.

  • Access Crawling module, worker, and database versions.

code

guide

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).

code

guide

Schema

Manage Coveo for Salesforce schemas.

code

N/A

Search

code

guide

Search Pages

Manage hosted search pages in a Coveo organization.

code

N/A

Search Usage Metrics

Review search consumption data.

code

N/A

Security Cache

  • Manage non-SAML security identity providers for a Coveo organization.

  • Manage security cache refresh schedules.

code

guide

Source

Manage sources and their related field mappings, as well as and pre-conversion and post-conversion Coveo indexing pipeline extensions.

code

guide

Source Logs

Access the Coveo indexing pipeline logs of a source.

code

N/A

Usage Analytics Read

Access usage analytics data (statistics, reports, dimensions, metrics, etc.).

code

guide

Usage Analytics Write

Record Coveo Usage Analytics (Coveo UA) events (click, search, view, or custom events).

code

guide

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.

What's next for me?