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 Recommendations Configuration API

The Recommendations Configuration API from Coveo — 7 operation(s) for recommendations configuration.

Coveo Recommendations Configuration 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 Recommendations Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

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

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

12 operations 7 paths 9 schemas 1 DELETE7 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Coveo Recommendations Configuration API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 12

Across 7 paths, the API surfaces 12 operations — 1 DELETE, 7 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Recommendations Configuration 12
GET
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/{configurationId}
Retrieves a Slot Configuration
getSlotConfiguration 2 params → 200
PUT
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/{configurationId}
Update a Slot Configuration
updateSlotConfiguration 2 params body → 200
DELETE
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/{configurationId}
Deletes a Slot Configuration
deleteSlotConfiguration 2 params → 204
GET
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/{configurationId}/settings
Retrieves Slot Settings
getSlotSettings 2 params → 200
PUT
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/{configurationId}/settings
Update Slot Settings
updateSlotSettings 2 params body → 200
GET
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/global/query-configuration
Retrieves a Global Query Configuration
getGlobalQueryConfiguration 2 params → 200
PUT
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/global/query-configuration
Update a Global Query Configuration
updateGlobalQueryConfiguration 2 params body → 200
GET
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots
Retrieves All Slot Configurations of an Organization
getSlotConfigurations 4 params → 200
POST
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots
Create a Slot Configuration
createSlotConfiguration 1 param body → 201
GET
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/{configurationId}/strategies
Retrieves Available Slot Strategies
getSlotStrategies 2 params → 200
GET
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/strategies
Retrieves Available Slot Strategies
getSlotStrategies_1 3 params → 200
GET
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/names
Retrieves All Slot Configuration Ids & Names of an Organization
getSlotConfigurationNames 5 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SlotConfigurationModel (11 properties), SlotSettingsModel (7 properties), CommercePageModelSlotConfigurationModel (3 properties), CommercePageModelSlotConfigurationNameModel (3 properties). Each schema is shown below with its type and property counts.

SlotSettingsModel
object
7 properties 6 required
CommercePageModelSlotConfigurationModel
object
Page
3 properties 3 required
SlotConfigurationNameModel
object
The retrieved page of items.
2 properties 1 required
SlotStrategiesModel
object
2 properties
Recommendation.QueryConfigurationModel
object
Query configuration.
2 properties 1 required
SlotConfigurationModel
object
11 properties 7 required
Headline
object
Localized recommendation headlines.
2 properties 2 required
StrategiesModel
object
The strategies for the slot.
2 properties
CommercePageModelSlotConfigurationNameModel
object
Page
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-recommendations-configuration-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 Recommendations Configuration 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.