PageBuilder Editor: Integrated Query Building Experience
The integrated query building feature in PageBuilder Editor lets you build and filter queries using powerful search capabilities and preview query results ahead of applying and saving it to your block.
Using this integrated experience you can:
create highly customized queries with an easy-to-use filter form
preview the content that will display in your block
apply your filtered query search to your block
Getting started with integrated query builder experience
For blocks that have this feature enabled (see Enabling the integrated query builder experience on your blocks), select story-feed-querybuilder under Content Source in the block’s Data Configuration section. You will then see the new Add filters to query form button. Upon clicking the Add filters to query form button, you’ll enter the integrated query building experience.
There are two components that make up this experience:
Query preview
Filter query form
Query preview
The Query preview displays preview cards of the content that is the output of your query.
Preview cards display the content’s title, thumbnail image, and type of content (for example, story, gallery or video).
Query preview feed displays up to 20 preview cards.
Upon initialization, Query Preview will display the 20 most recently published stories, galleries, and videos.
To see results that are beyond the 20 most recently published content items, update the Offset start field in the Filter query form to a number 21 or above. Query preview will then update to reflect preview cards that are within the updated range.
Preview cards that are highlighted are the selected stories/galleries/videos that will display in your block’s feed. The number of cards that are highlighted and which item your feed starts with are based off of the Selected size field and Offset start field inputs in the Filter query form.
 |
Filter query form
To refine your query, you can filter your query preview results by using the filter and search options.
 |
You can filter and search for content for your query by the following parameters:
Content type - This includes stories, videos, galleries, or by all content
Section/ sub-section - This field returns stories that appear in
Tag - This field allows you to filter stories by a given tag. In order to return results, you will need to input the tag slug that corresponds to your tag. You can view your tag’s slug under Manage Tags in Global Settings.
Author - This allows you to filter stories by a given author. For this field, simply enter the author’s name. You do not need to enter it as a slug.
Date - This includes the ability to sort by publish date, display date, first publish date, last updated date.
Selected size - This determines the number of stories/galleries, or videos you want to display in your block.
Offset start - This controls which story in the feed you would like to start with.
AND/OR/NOT operators: For each field, there is an multi-dropdown field that allows you to easily apply AND, OR, and NOT logic to your query.
Setting up, previewing and saving your query
Let’s walk through how you would set up, preview, and save a query that includes Composer stories that have vegetarian recipes to your feed-based block.
First, under Content Type, check the Stories check box. This will then update your Query preview to display preview cards that are only Story content types.
In order to create a feed of stories that feature vegetarian recipes, within the Tags input field, a user will first add the recipe tag slug. To add the vegetarian tag dimension to your query, select AND from the AND/OR/NOT drop-down list and add the vegetarian tag slug. Query preview will now display Composer stories that include both metadata tags.
In the Query details section, you can input the number of stories they wish to display in their block and which story they would like to start with using the Select size field and Offset start field. For this block, we want to have 3 stories display and ensure that there are no duplicate stories on the page so include an Offset start of 1.
Using Query preview, a user can see which stories will display in their block based off of the highlighted preview cards.
Once you are satisfied with your query’s content, click the Save filter button that can be found in the Filter query form panel. This closes the integrated query builder experience and your block in Editor Preview will display the updated content feed.
Enabling the integrated query builder experience on your blocks
In order to leverage the integrated query building experience on your feed-based blocks, you must create a QueryBuilder content source and update your organization’s bundle. See How to Enable Integrated Query Builder Experience for PageBuilder Editor.
Q&A
Q1 - What privileges do I need to use the integrated query building experience in PageBuilder Editor?
A. You will need “Write” or “Write and Publish” permissions in PageBuilder Editor.