usageanalytics.coveo.com endpoint deprecation
usageanalytics.coveo.com endpoint deprecation
The usageanalytics.coveo.com
endpoint is being deprecated.
Beginning December 9, 2024, all calls to this endpoint will fail, your usage analytics will no longer be recorded, and the relevance of your search results will be impacted.
Coveo strongly recommends that all Coveo for Sitecore customers upgrade to the latest version and migrate to organization endpoints. Upgrading to the latest Coveo for Sitecore release simplifies the transition to organization endpoints and ensures that your instance is using the most up-to-date endpoints, features, and improvements.
|
The multi-release upgrade procedure speeds up the upgrade process. |
If an immediate upgrade to the latest release of Coveo for Sitecore isn’t feasible, refer to the instructions associated with your current version of Coveo for Sitecore below to ensure you no longer use deprecated endpoints.
May 9, 2023 (5.0.1227.1) or October 23, 2023 (5.0.1277.4)
You’re not using the deprecated analytics endpoint, so no action is required.
However, Coveo strongly recommends that you upgrade to the latest version. Follow all upgrade steps including the organization endpoints migration steps.
September 18, 2020 (5.0.788.5) to February 15, 2023 (5.0.1202.1)
Short of upgrading to the latest release and enabling organization endpoints, ensure you’re using non-deprecated endpoints in your configuration files.
-
In
<SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo\Coveo.CloudPlatformClient.Custom.config
, make sure that the<cloudPlatformUri>
value is one of the following:<cloudPlatformUri>https://platform.cloud.coveo.com</cloudPlatformUri>
If your Coveo organization uses regional endpoints, make sure you’re using the relevant region-specific endpoint (for example,
https://platform-eu.cloud.coveo.com
). -
In
<SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo\Coveo.SearchProvider.Rest.Custom.config
, make sure that the<analyticsUri>
value is one of the following:<analyticsUri>https://analytics.cloud.coveo.com/rest/ua</analyticsUri>
If your Coveo organization uses regional endpoints, make sure you’re using the relevant region-specific endpoint (for example,
https://analytics-au.cloud.coveo.com/rest/ua
).
|
Note
You can use PowerShell configuration and activation scripts to make these changes in your Sitecore instance. ConfiguringThis function configures Coveo for Sitecore by applying the passed parameters values on the corresponding configuration files. It can be called either to fully or partially configure the instance.
If Coveo configuration files still have the ActivatingThis function activates Coveo for Sitecore by renaming the
Usage examplesOnce the previous functions are added to your PowerShell script tooling, you can use them to configure and activate Coveo for Sitecore. Here is an example of how to call them with the right parameters:
You need to replace:
|
Versions older than September 18, 2020 (5.0.788.5)
You’re using the deprecated analytics endpoint and your implementation is severely outdated.
Upgrade to the latest version of Coveo for Sitecore and follow the steps to migrate to organization endpoints.
If you’re using Coveo for Sitecore 4.0 or 4.1, identify your upgrade scenario and follow the related instructions to upgrade to the latest version of Coveo for Sitecore 5.