When Coveo was launched, there were only a few API endpoints for search requests and analytics events. As Coveo has grown, the need for organization endpoint URLs has become increasingly important for several reasons:
- Clear Separation: Client-specific subdomains create clear boundaries between different clients
- This helps to isolate specific environment to an organization.
- Independent Scaling: Ability for Coveo Infrastructure to scale specific client based on license.
- Coveo Infrastructure Security:
- Isolation: Client-specific subdomains can isolate API traffic
- IP Whitelisting: By restricting access to specific IP addresses through the subdomain.
- Better Performance
<ORD_ID>.org.coveo.com - Search requests
<ORD_ID>.analytics.org.coveo.com - Usage Analytics logging
<ORD_ID>.admin.org.coveo.com - Organization administration
Currently, analytics.cloud.coveo.com
is the designated domain for sending analytics events. Previously, platform.cloud.coveo.com
served multiple purposes, including the Coveo Administrator console, search requests, and analytics. Coveo is deprecating the use of platform.cloud.coveo.com
for analytics events. As of December 9th, 2024 June 3rd 2025 (updated on 11/14/2024), any analytics events sent to this domain will be ignored or result in errors. Along with this change, analytics.cloud.coveo.com is also marked as Suboptimal endpoint which encourages to use organization specific endpoint.
How to check the current endpoint usage:
How to update the endpoint in Sitecore:
- Open Sitecore CM Control Panel, and select Configuration Manager under Coveo Search. Coveo Command Center will be opened in a new tab.
- In Coveo Command Center, click Log in.
- Log in to your Coveo organization.
- Click Apply and Restart.
- This action triggers Coveo for Sitecore to Switch to Organization Endpoints.
Under the hood:
- Key: cloudPlatformUri
- Value: Changed from
https://platform.cloud.coveo.com
to https://<ORG_ID>.admin.org.coveo.com
- Key: cloudGeneralPlatformUri (newly added)
- Value:
https://platform.cloud.coveo.com
- Key: analyticsUri
- Value: Changed from
https://analytics.cloud.coveo.com
to https://<ORG_ID>.analytics.org.coveo.com
- Key: searchApiUri
- Value: Changed from
https://analytics.cloud.coveo.com
to https://<ORG_ID>.org.coveo.com
Updated the new deadline to June 3rd 2025.
ReplyDelete