Review Search event and API request health

This is for:

Developer
Important

The Commerce Health dashboard is in early release and is being rolled out progressively. If it isn’t yet visible in your Coveo Merchandising Hub (CMH) interface, check back soon.

This article explains how to review event, request, and catalog field health for the Search tab of the Commerce Health dashboard. It also covers the readiness checks for the machine learning (ML) Catalog Semantic Encoder (CSE) model.

Cards on this tab show one of three statuses: Healthy, Degraded health, or Insufficient health. Open any card to view a detailed breakdown of the underlying issues.

Indicator color State Details

Green green

Healthy

No issues impacting performance.

Yellow yellow

Degraded health

Issues detected that may affect feature performance.

Red red

Insufficient health

Critical data health issues detected that may prevent affected features from working as expected.

Prerequisites

To review the Search tab of the Commerce Health dashboard, make sure you have the following:

  • Access to the Coveo Merchandising Hub (CMH) with privileges to view the Health dashboard.

  • A Commerce implementation that sends search events through the Event Protocol or Commerce API.

Search features

The Search features section shows whether the Catalog Semantic Encoder (CSE) model has the event and catalog data it needs:

  • If the CSE isn’t yet activated and your data is healthy, the section will indicate Ready for activation with no major issues detected. You can therefore activate the model on the Models (platform-ca | platform-eu | platform-au) page of the Coveo Administration Console.

  • If the dashboard checks found issues in your data or configuration and you don’t have the model activated yet, the section will indicate Resolve issues before activation.

    • Click View details and the Catalog Semantic Encoder page opens.

    • Assess the event issues and checks that need to be fixed before you activate the model.

  • If the dashboard checks found issues in your data or configuration and you already have the model activated, the section will indicate Issues detected that could impact performance.

    • Click View details and the Catalog Semantic Encoder page opens.

    • Assess the event issues and checks that are impacting the model’s performance.

Note

If CSE isn’t available for your organization, either because of your license limitations, or because your catalog size is outside the supported range, the section will indicate that the feature isn’t available instead of showing health information.

Events & API requests

The event and request health sections help you confirm whether the expected activity is being collected relative to the Catalog Semantic Encoder (CSE) model.

A line chart shows the daily volume of each event type over the selected date range, letting you compare trends across event types rather than their health. Each event type has its own color and can be added or removed using the Show filter above the chart. Hover over a point to see the date and the count for each visible event type on that day.

Events section

The Events section contains commerce events cards relative to the Catalog Semantic Encoder (CSE) model:

  • Search

  • Click on search result

  • Product view

  • Purchase from search

  • Cart

Use these cards to identify whether expected events or requests are healthy, invalid, or showing issues that require investigation.

To explore event issue breakdowns:

  1. Click View details next to any of the available cards.

  2. On the Event health page that opens, view the Event issues bar chart to analyze the number of healthy and invalid events. The chart shows one stacked bar per day in the selected date range, with the healthy (green) and invalid (red) event counts for that day. A day with a large red segment relative to green can indicate a spike in invalid events, helping you determine whether an issue is ongoing or was isolated to specific days, such as a deployment or source refresh.

  3. Hover over a day’s bar to see the date along with the total healthy and invalid event counts for that day.

  4. Under the bar chart, click chevron-down to expand any of the issues detected. The expanded table will show sample event properties, description, and values.

Note

Event samples are retained for seven days. Expanding a day outside the seven-day retention window won’t show any event samples, even though the bar chart continues to show historical counts for the full selected date range.

Event checks

The Event checks section provides an overview of the different health checks available for search-related events.

Valid product IDs across events

The Valid product IDs across events card checks whether the product IDs sent in events can be found in the catalog.

To analyze which product IDs were flagged as not existing in the commerce catalog:

  1. Click View details.

  2. On the Valid product IDs across events page that opens, view the Impacted events ring chart, which shows the ratio of impacted to total events.

Catalog fields

The Catalog fields compliance section lists the standard commerce catalog fields required by your AI models and reports. Each field is shown as a progress bar with its compliance percentage, which represents the share of catalog products where that field is present and valid. If a feature has both required and optional fields, a Required/Optional filter lets you switch between the two sets.

Note

Which fields are required for Catalog Semantic Encoder depends on your model configuration. For example, ec_description is required only if description is configured as a text column for the model, and is required by default if no text columns are configured. The same logic applies to ec_shortdesc, ec_name, ec_brand, and ec_category.

The progress bar color reflects a quality threshold for that field:

Status Meaning

Good green

This field meets its quality threshold.

Degraded yellow

Data quality issues in this field may affect features that use it.

Insufficient red

This field doesn’t meet its quality threshold. Review the affected feature’s requirements before activation.

At the top of the Catalog fields compliance card, you can do either of the following:

  • Click external-link next to the product total on the upper-left corner. This opens the Content Browser in the Coveo Administration Console, where you can investigate further.

  • Click View catalog on the upper-right corner. This opens the Catalogs page in the Coveo Administration Console, where you can configure the catalog further.

To investigate a specific field:

  1. Click Details next to the field.

  2. On the <field name> health page that opens, review the three product counts: Healthy, Invalid, and Incomplete, each shown with a count and percentage.

  3. View the bar chart to analyze how these three counts changed over the selected date range. Hover over a day’s bar to see the date along with the total healthy, invalid, and incomplete product counts for that day.

  4. Under the bar chart, click an issue, such as Incomplete, to show or hide the list of affected products.

  5. For each affected product, review the product name, a link to the product detail page, and the specific invalid or missing value.

Catalog checks

Catalog has products

The Catalog has products card checks whether the catalog is populated with identifiable products.

To assess catalog product discrepancies:

  1. Click View details.

  2. On the Catalog has products page that opens, a table shows a sample of products from the catalog. Click Edit to open the catalog configuration in the Coveo Administration Console.

    1. Review and update the catalog configuration, then click Save.

  3. Click external-link next to the product name to view the product web page.

Matching product ID and index field

The Matching product ID and index field card checks whether the selected metadata field names match indexed field names.

To view match issues:

  1. Click View details.

  2. On the Matching product ID and index field page that opens, the differing metadata are listed under Different metadata field name and indexed field name. Click Edit on any of the listed product IDs or mapping rule values.

    • If you clicked Edit next to a product ID, the Catalog page where the product exists opens in the Coveo Administration Console. Configure the product as needed, and then click Save.

    • If you clicked Edit next to a mapping rule, the Source page where the field mapping rule exists opens in the Coveo Administration Console. Configure the mapping rule as needed, and then click Save.

  3. Click external-link next to the product name to view the product web page.

Valid product and permanent ID mapping

The Valid product and permanent ID mapping card checks whether the permanent IDs in the source match the product IDs defined in the catalog configuration.

To view mapping issues:

  1. Click View details.

  2. On the Valid product and permanent ID mapping page that opens, the differing values are listed under Product and permanent ID values don’t match. Click Edit on any of the listed product IDs or mapping rule values.

    • If you clicked Edit next to a product ID, the Catalog page where the product exists opens in the Coveo Administration Console. Configure the product as needed, and then click Save.

    • If you clicked Edit next to a mapping rule, the Source page where the field mapping rule exists opens in the Coveo Administration Console. Configure the mapping rule as needed, and then click Save.

  3. Click external-link next to the product name to view the product web page.

Leading practices

  • Notifications

    Click bell and subscribe to notifications for when the health status of a CSE or LPO model changes for a specific property and locale. When subscribed, notifications are sent when a feature’s status degrades, so you can catch and fix any issues early. You also receive a notification when it improves, so you know when a previously blocked feature becomes ready to activate.

  • Mute checks

    You have the option to mute checks in each card of the Health dashboard. Toggle Mute where there’s a check that isn’t necessary for your implementation.

  • Coveo Explorer

    Event checks like Valid product IDs across events can be inspected in the Coveo Explorer Chrome extension. Use it to validate captured events in real time as you browse your store.

  • Impacted features

    Every Health page you access by clicking View details contains an Impacted features section that lists the AI models affected by that card or field’s compliance. Use it as another way to navigate to the Catalog Semantic Encoder detail page.