Push source item metadata

Metadata is a key-value pair that typically provides a single specific piece of information about an item (for example, its author name). You can push as many distinct metadata key-value pairs as you need with each individual item you add or update in a Push source.

To be useful, metadata must populate at least one field in the index of your Coveo organization. By default, when the Coveo indexing pipeline processes a Push source item, it tries to map each incoming metadata key to a field of the same name in the index.

Notes
  • Only a few Coveo source types support automatic mapping for incoming item metadata, the Push source is one of them. With many other source types, you must define mapping rules explicitly to populate index fields with incoming metadata.

  • You can also configure the Push source with custom mapping rules for specific metadata. These rules override the default automapping for the specified metadata.

In summary, if you plan to include a metadata key-value pair when adding or updating an item in a Push source, first ensure you create a field with the same name in your index, unless you plan to define a custom mapping rule to handle the metadata.

The following diagram provides a simplified overview of the metadata-to-field mapping process for incoming Push source items:

About Push Source Item Metadata Diagram

The articles in this section help you push item metadata effectively: