Skip to end of metadata
Go to start of metadata

The Coveo Cloud V2 platform is an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems. The platform relies on Coveo Cloud usage analytics data to yield Coveo Machine Learning powered recommendations. The Coveo Cloud V2 platform embraces the concepts of micro-services and scalability, allowing users to expand their search solution as their business grows.

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

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

Coveo Cloud V2 REST APIs

API nameUsageReference documentation
SearchSearch API
Usage Analytics WriteUsage Analytics Write API
Usage Analytics Read
  • Access the usage analytics data of a Coveo Cloud V2 organization (statistics, reports, dimensions, metrics, etc.).
Usage Analytics Read API
Platform
  • Create, update, or delete a Coveo Cloud V2 organization.
  • Access a Coveo Cloud V2 organization status, login activity, license, and limit information.
Platform API
Source
  • Manage sources and their related field mappings and indexing pipeline extensions.
Source API
Push
  • Push items, identities, and permissions to a push source (as opposed to pulling content into a standard source using Coveo Cloud crawlers).
Push API
Index
  • Access the permission models of indexed items.
Index API
Fields
  • Manage fields in an index.
Field API
Extension
  • Manage and test indexing pipeline extensions.
Extension API
Source Logs
  • Access the indexing pipeline logs of a source.
Source Logs API
Activity
  • Access the activity information of a Coveo Cloud V2 organization.
Activity API
Notification
  • Manage and test activity notification subscriptions for a Coveo Cloud V2 organization.
Notification API
Authorization Server
  • Manage SAML security identity providers for a Coveo Cloud V2 organization.
  • Manage groups, members, and API keys in a Coveo Cloud V2 organization.
Authorization Server API
Security Cache
  • Manage non-SAML security identity providers for a Coveo Cloud V2 organization.
  • Manage security cache refresh schedules.
Security Cache API

Generated Swagger UI Documentation Site

You can visualize the API reference documentation and test API calls using the generated Swagger UI Coveo Cloud V2 API reference documentation site (see Coveo Cloud Platform API).

  • No labels