Organization endpoints

This is for:

In this article

Search endpoint
Analytics endpoint
Admin endpoint
Integrations

On June 3, 2025, Coveo deprecated older endpoints and make other endpoint-related changes. However, since Coveo can’t review your code, you must make sure that your implementation wasn’t impacted by these changes. Therefore, you should check your Coveo implementation and make the necessary changes as soon as possible, if applicable.

See Endpoint deprecation and other endpoint-related changes and Detailed endpoint-related changes for details.

Until 2023, depending on where your primary deployment region was located, you needed to use region-specific endpoints to send Coveo API requests. For example, if your primary region was Ireland, you needed to use platform-eu.cloud.coveo.com/rest/search to send requests to the Search API. Other than the Push API, which still requires region-specific endpoints, you no longer need to use region-specific endpoints.

To improve separation of concerns and resiliency and to make multi-region and data residency deployments smoother, we have introduced organization endpoints. Besides the generic platform endpoints (platform-<REGION>.cloud.coveo.com), which will keep working, three kinds of endpoints are now generated for each Coveo organization, based on its ID:

<ORG_ID>.org.coveo.com (Search requests)
<ORG_ID>.analytics.org.coveo.com (Usage Analytics logging)
<ORG_ID>.admin.org.coveo.com (organization administration)

Similarly, three kinds of endpoints are also generated for each HIPAA organization, based on its ID as an alternative to platformhipaa.cloud.coveo.com:

<ORG_ID>.orghipaa.coveo.com (Search requests)
<ORG_ID>.analytics.orghipaa.coveo.com (Usage Analytics logging)
<ORG_ID>.admin.orghipaa.coveo.com (organization administration)

With these new endpoints, you no longer need to keep track of the location of your primary deployment region. These endpoints are region agnostic and will automatically route requests to the region offering the lowest latency. Whether your deployment strategy is data residency or multi-region, use the newly created organization-specific endpoints for more seamless interaction with Coveo APIs and to facilitate query rerouting if a problem occurs.

You can review your current and recommended endpoints in your organization settings, under Traffic (platform-ca | platform-eu | platform-au).

Alternatively, you can call the global configuration endpoint.

When migrating to organization endpoints, make sure to update your Content Security Policy (CSP) to allow requests to the new endpoints.

Search endpoint

For Search requests, use:

<ORG_ID>.org.coveo.com/rest/search for a non-HIPAA organization
<ORG_ID>.orghipaa.coveo.com/rest/search for a HIPAA organization

Those endpoints cover requests made to:

/rest/search/*
/rest/organizations/<ORG_ID>/machinelearning/user/actions

For technical reasons, requests to the following endpoints are supported through redirections to the primary deployment region (that is, slower response times can be observed when queries are routed to satellite regions).

/rest/organizations/<ORG_ID>/commerce/*
/rest/organizations/<ORG_ID>/caseassists/*
/rest/organizations/<ORG_ID>/insight/*
/rest/organizations/<ORG_ID>/ipxinterface/v1/interfaces/<INTERFACE_ID>/loader

Atomic

v3

Atomic v3 automatically enforces the use of organization endpoints.

v2

Note

Only available since Atomic v2.23.4

If using the Atomic library v2, set the organizationEndpoints parameter using the getOrganizationEndpoints function when initializing your atomic-search-interface, as seen in the following code. The library will infer which endpoints to use.

(async () => {
  await customElements.whenDefined('atomic-search-interface');
  const searchInterface = document.querySelector('#search');

    await searchInterface.initialize({
      accessToken:'<ACCESS_TOKEN>',
      organizationId: '<ORGANIZATION_ID>',
      organizationEndpoints: await searchInterface.getOrganizationEndpoints('<ORGANIZATION_ID>'),
    });

  searchInterface.executeFirstSearch();
})();

For a HIPAA organization, pass hipaa as an argument to getOrganizationEndpoints, as follows:

getOrganizationEndpoints('<ORGANIZATION_ID>', 'hipaa')

Headless

v3

Headless v3 automatically enforces the use of organization endpoints.

v2

Note

Only available since Headless v2.12.0

If using the Coveo Headless library v2, set the organizationEndpoints parameter using the getOrganizationEndpoints function in your SearchEngineConfiguration when initializing your Headless Search Engine (or analogously for other kinds of engines), as seen in the following code. The library will infer which endpoints to use.

export const headlessEngine = buildSearchEngine({
  configuration: {
    organizationId: "<ORGANIZATION_ID>",
    accessToken: "<ACCESS_TOKEN>",
    organizationEndpoints: getOrganizationEndpoints('<ORGANIZATION_ID>'),
  }
})

For a HIPAA organization, pass hipaa as an argument to getOrganizationEndpoints, as follows:

getOrganizationEndpoints('<ORGANIZATION_ID>', 'hipaa')

JavaScript Search Framework

If using the Coveo JavaScript Search Framework, set your search endpoint to https://<ORG_ID>.org.coveo.com/rest/search or https://<ORG_ID>.orghipaa.coveo.com/rest/search, depending on whether your organization is HIPAA or not. For example:

Coveo.SearchEndpoint.configureCloudV2Endpoint("<ORG_ID>", "<SEARCH_TOKEN>", "https://<ORG_ID>.org.coveo.com/rest/search");

Analytics endpoint

To log Coveo Analytics, use:

<ORG_ID>.analytics.org.coveo.com/rest/ua/ for a non-HIPAA organization
<ORG_ID>.analytics.orghipaa.coveo.com/rest/ua/ for a HIPAA organization

These analytics endpoints let ad blockers distinguish between analytics and non-analytics requests sent to the Coveo platform. As a result, ad blockers can target and block requests to log Coveo Analytics events specifically, preventing issues with Search requests.

Those endpoints cover requests made to:

/rest/v15/analytics/*
/rest/v14/analytics/*
/rest/organizations/{organizationId}/events/**

Atomic and Headless

If using the v3 Atomic or Headless libraries, the libraries enforce the use of organization endpoints for analytics logging. If using v2, specify the organizationEndpoints parameter using the getOrganizationEndpoints function, as specified previously, lets the library infer which analytics endpoint to target.

JavaScript Search Framework

If using the Coveo JavaScript Search Framework, set your analytics component data-endpoint property. The property must use one of the following formats depending on your JavaScript Search Framework version and whether your organization is HIPAA or not.

Non-HIPAA organization

Coveo JavaScript Search Framework v2.8864 (April 2020) or later:
```
https://<ORG_ID>.analytics.org.coveo.com/rest/ua
```
Coveo JavaScript Search Framework v2.8521 (March 2020) or earlier:
```
https://<ORG_ID>.analytics.org.coveo.com/
```

HIPAA organization

Coveo JavaScript Search Framework v2.8864 (April 2020) or later:
```
https://<ORG_ID>.analytics.orghipaa.coveo.com/rest/ua
```
Coveo JavaScript Search Framework v2.8521 (March 2020) or earlier:
```
https://<ORG_ID>.analytics.orghipaa.coveo.com/
```

Example

For a non-HIPAA organization that’s using Coveo JavaScript Search Framework v2.8864 or later:

<div class="CoveoAnalytics" data-endpoint="https://myorganization-bfghkjfjb674jh5egjk.analytics.org.coveo.com/rest/ua"></div>

Admin endpoint

Use <ORG_ID>.admin.org.coveo.com and <ORG_ID>.admin.orghipaa.coveo.com instead of platform-<REGION>.cloud.coveo.com and platformhipaa.cloud.coveo.com to perform administrative API calls, including reading UA reports. These endpoints can be used for most Coveo API requests outside UA logging. While they can technically be used for search, you should use the search endpoints introduced earlier instead. A further advantage is that you no longer need to know your main region to navigate to the Administration Console. As a test, type in <ORG_ID>.admin.org.coveo.com with your specific <ORG_ID> into your browser to access the Administration Console. You’ll be automatically redirected to the proper region endpoint.

Integrations

Certain Coveo integrations require a configuration that differs from what’s explained in the preceding sections of this article.

Coveo for Sitecore

To configure organization endpoints in a Coveo for Sitecore deployment, see Migrate to organization endpoints.

Coveo for Salesforce

To configure organization endpoints for a Coveo for Salesforce deployment, see Using the Advanced Configuration page.

Coveo for ServiceNow

By default, Coveo for ServiceNow integrations use organization endpoints for search and usage analytics requests. No additional configuration is required. However, if your Coveo for ServiceNow requests must go through a proxy server or a specific region endpoint in a multi-region deployment, you can disable the organization endpoints feature.