How to filter web content by structure field with headless APIs

Issue

• Create a custom structure and use a headless API to filter web content based on specific fields within that structure

Environment

• Quarterly Releases
• DXP 7.4
• DXP 7.3

Resolution

• The following endpoint should be used getContentStructureStructuredContentsPage :

  • /o/headless-delivery/v1.0/content-structures/<structure-id>/structured-contents?filter=<filter>

• The following format could be used contentFields/<Field-Reference> for custom structure fields.
  • The field reference could be obtained when editing the web content structure.
  • For example, the following expression could be used to filter web content by a field "Example" having value 'value'  (contentFields/Example eq 'value')
• The filter format for structure fields contentFields/<Field-Reference> is not available for other Headless APIs such as getStructuredContentFolderStructuredContentsPage, getSiteStructuredContentsPage, ...
  • You could build your own custom search blueprints and use the Search API as an alternative.
• Only fields indexed as a keyword support filtering.

Additional Information

• API Query Parameters 
• Filterable Properties (7.2) 
• Filter Sort and Search concepts (7.2)
• OData Filter Operations (External link)
• How to set up Search Blueprints to be used with Search headless API 
• LPS-139326 - Headless API cannot filter Web Content by select field 
• Headless Delivery API - Filtering structured content (Similar article for DXP 7.2)