Optimized content search exploiting key metadata

Business Case:

KPI to be measured

Bookmark this resource Follow

Ask a question

Was this article helpful? 1 out of 1 found this helpful

Key metadata is a specific metadata built to perform optimized search on specific categories of content. For example, you might want to set a key metadata related to a specific product code in order to retrieve all content related to a specific product. In order to properly exploit this metadata for your content search activities, you need to know following characteristics:

  • it can be related only to one tag at a time,
  • maximum length is 100 characters,
  • it can not contain special characters,
  • it can not contain spaces,
  • it is not localized (monolingual).

Such constraints refer to the key of the metadata, the only constraint on their values is the length which must be lower than 100 characters.

Further information on how to create a metadata and relate it to a specific tag can be found on this article.

To perform a search exploiting such metadata you will have to use a findByProperties request, providing the following JSON:

    "client": {
        "clientId": ""
    "criteria": {
        "linkedCategories": [
        "imetadataKeyOp": {
            "imetadata": [{
                "classificationId": "",
                "key": "",
                "value": ""

You will be able to provide up to five key metadata simultaneously: the search will return all content with at least one of the provided metadata matching the value included in the request. Please be aware that both the key and the value of each metadata is case sensitive.

Moreover, you will be able to combine this type of search with one of the search methods illustrated in this article by adding either the itagOp or the textSearch parameters.

Was this article helpful?
1 out of 1 found this helpful

Have any question?

Open a ticket