Creating screen views

Select documents and Brickworks records to be displayed on your website or in your mobile application for the defined audience.

Requirements

A complete list of requirements is available in this article.

Creating a screen view

1. Go to Experience Hub > Screen views > Create screen view.
2. Enter the name of the screen view.

Selecting recipients

3. To define the recipients of your screen view, in the Audience section, click the Define button. You can choose the audience in the following ways:

   • You can select all customers to be the audience of your screen view by clicking the Everyone option.
   • You can choose segmentations of your customers by clicking the Segment button.
   • You can choose the recipients of your screen view from scratch by clicking the New audience option.
     • You can also create segments, profile aggregates, and profile expressions directly in the filter by selecting Add local segment, Add local profile aggregate, or Add local profile expression. For details, see Inline analyses.
4. Confirm your choice by clicking the Apply button.
   
   IMPORTANT: If the audience of the screen view is more than one segmentation and one of the segmentation returns 0 results, then the whole audience is 0. In such circumstances, such a screen view will not be visible when active.
   

Creating content

5. To create the content of your screen view, in the Content section click the Define button.

   

   1. From the Screen views feed dropdown feed, select a feed to which a screen view will be assigned. If needed, you can create a new screen view feed:

      1. Click Add screen views feed.

      2. On the pop-up, in the Feed name field, enter the name of the feed. It will be only visible in the Screen views feed dropdown.
      3. In the Slug field, enter a unique identifier of this screen views feed. While retrieving screen views to a dedicated space on your website or in your mobile application, you will use this slug to display all screen views assigned to a particular feed.
         
         NOTE: We recommend following this slug name convention: your-slug-name. Special characters and white spaces are unsupported.
         
      4. Confirm by clicking Apply.
   2. In the Priority field, define the order in which a screen view will be displayed. Use numbers from 1 to 99, where 1 is the highest. The default value is 99.
   3. If you want to extend the structure of the screen view beyond the content you select, enable the Use customized screen view structure option.

      1. In the text editor, enter the JSON structure of the screen view.
         It must contain the {% screenviewcollection %} tag which inserts all documents and Brickworks records you select in the Content to display section. This tag is included by default, but you can move it when changing the JSON structure.
         You can also use the {% document <slug> %} tag to refer to a single document.
         Other inserts can be used too. Example structure of the screen view:

         {
           "content": {
             "collection": "{% screenviewcollection %}",
             "document": "{% document currentpromotions %}",
             "yourCustomParameter": "string"
           }
         }

6. In the Content to display section, select whether you want to add content one by one (Selected content tab) or from document groups (Document groups tab), and follow the relevant instructions. You can use only one tab in a screen view.

   • Selected content: add documents and Brickworks records one by one.
     1. Click the Selected content tab.
     2. Click Add content.
     3. In the Add content window, in the left panel, select the source:
        • To browse documents, under Documents, click All.
        • To browse Brickworks records, under Brickworks schemas, click a schema.

        

     4. Select the checkboxes next to the content items you want to add.
        • You can select content items from different sources, for example documents and records from several schemas, before you click Apply.
        • You can add records in any state (for example, drafts), but only published records are displayed in the screen view. For more details, see Brickworks records in a screen view.
     5. Click Apply.
     6. To change the order of the content, drag and drop the content items on the list.
        The order you set overrides the priority of individual documents. For more details, see Order of displaying content in a screen view.
     7. Optionally, to open the details of a content item or check its ID, click the icon next to it.
     8. Optionally, to remove a content item from the list, point to it and click the icon.
   • Document groups: add all documents assigned to document groups.
     1. Click the Document groups tab.

        

     2. Click the Select document groups field and select one or more groups.
     3. Click Add.
     4. By default, documents are displayed according to their priority, regardless of the group they belong to. To define the order of groups yourself, enable Enforce manual order. Documents within each group are still ordered by their priority.
        For more details, see Order of displaying content in a screen view.
     5. To check which documents the screen view will include, click Preview documents list.
7. Confirm by clicking Apply.

Scheduling screen view campaign

8. In the Schedule section, click Define.
   1. To display the screen view immediately after the activation, click the Run immediately section.
   2. To schedule the display of the screen view at a future date, click Scheduled.
   3. For both options, you can set time windows (the Set time windows option) during which the content of the screen view will be visible to customers.
9. Confirm the settings in the Schedule section.
10. To publish the screen view, in the upper right corner, click Activate.

You may want to know

Order of displaying content in a screen view

While creating screen views, you can define the order of displaying content:

• For documents and Brickworks records added in the Selected content tab:
  The order of displaying content is defined only manually: drag and drop the content items in the preferred order. The priority settings of documents are overridden.
  
  Click here to see example

  

  In the example on the screen above, the order of displaying content will be as presented on the UI, which means the content item at the top of the list will be presented first, regardless of whether it's a document or a Brickworks record.
  

• For the groups of documents (the Document groups tab):

  • By default, the order of the documents selected this way is defined on the basis of priority of documents. This means that division into groups is overridden and the documents are displayed according to their priority settings.

    Click here to see example

    

    In the example on the screen above, the order of displaying documents will be as follows:

    1. `Carousel with accessories` document (priority 2)
    2. `reco-for-new-users` document (priority 3)
    3. `sneakers` document (priority 4)

  • By enabling the Enforce manual order option, you define the order of document groups, however, the documents within the groups will be shown according to document priority.

    Click here to see example

    

    In the example on the screen above (with the same groups as in the previous example), the order of displaying documents will be as follows:

    1. `reco-for-new-users` document (priority 3)
    2. `sneakers` document (priority 4)
    3. `Carousel with accessories` document (priority 2)

Conflicts

Your application always requests a screen view from a single screen views feed, so conflicts can only occur between screen views assigned to the same feed.

Screen views with the same priority

Expand for detailed logic

Documents with the same priority

This applies to documents added in the Document groups tab. The order of content added in the Selected content tab is defined manually.

Expand for detailed logic

A document in a screen view whose audience conditions are mutually exclusive with screen view audience

The document will not be displayed in a screen view.

Finished, paused or draft document in an active screen view

The document will not be displayed in a screen view.

Brickworks records in a screen view

• The screen view displays the latest published version of a record. If a record has no published version (it's a draft, it's scheduled for a future date, or it was unpublished) or if the record or its schema was deleted, the collection array contains an empty object ({}) in place of the record. Make sure your application handles empty objects. For more information about record states, see Record lifecycle.
• Dynamic fields and personalization of a record are rendered in the context of the profile that requests the screen view.
• A screen view refers to a record by its ID, not by its slug. If you change the slug of a record used in a screen view, you don't need to update the screen view: the record is still displayed, and the __slug field returns the new slug.
• Records inherit the audience of their schema. If the profile that requests the screen view doesn't belong to the audience of the record's schema, the record is returned only with its metadata (fields with the __ prefix), without the schema fields, and __matchedAudience is set to false. Make sure your application checks the value of __matchedAudience before it displays the record.
• When you add a record to a screen view, you don't get a warning if the audience of the record's schema conflicts with the audience of the screen view. A record always uses the audience of the latest version of its schema, even if the __schemaVersion field shows an earlier version. For details, see Editing schemas.

Content of a generated screen view

When a screen view is generated, the documents and Brickworks records you selected are returned in the collection array. Documents and records have different structures:

• A document contains its uuid, slug, and schema. The content of the document is nested in the content object.
• A record contains the fields of its schema at the top level of the object. The metadata of the record is returned in fields with the __ prefix, such as __id, __slug, __schemaId, __recordVersion, and __matchedAudience

The __matchedAudience field indicates whether the profile belongs to the audience of the record's schema.

{
  "data": {
    "collection": [
      {
        "uuid": "ec6b5e03-abe1-448c-a58c-01974553c0c4",
        "slug": "summer-sale",
        "schema": "collection",
        "content": {
          "title": "Summer sale"
        }
      }
    ]
  }
}

{
  "data": {
    "collection": [
      {
        "__slug": "summer-sale",
        "__recordVersion": 1,
        "__publishedAt": "2026-10-01T12:43:37.433221Z",
        "__updatedAt": "2026-10-01T12:43:37.419048Z",
        "__createdAt": "2026-09-29T11:58:14.529783Z",
        "__schemaId": "def4e381-b1ee-4e42-9dfb-cd6811f5b9d4",
        "__id": "ec04223a-953d-4ddd-8e98-51e0652d8fda",
        "__schemaVersion": 6,
        "__matchedAudience": true,
        "title": "Summer sale"
      }
    ]
  }
}

Screen view audience vs document audience

For screen view campaigns:

• you can select up to 20 documents whose audience is one segmentation or more.
• you can't select a document that contains other documents (inserted with the {% document %} tag) whose audience is other than Everyone.
• if the screen view audience and the audience of documents selected in the screen view is mutually exclusive, then the document won't be displayed in a screen view
• if a profile doesn't match the audience of any screen view in a feed, no screen view is returned for that profile

Screen view schedule vs document schedule

The screen view campaign displays only active documents.

• When a screen view contains the documents which are no longer active or are scheduled at the future date, they won't be displayed in a screen view.
• When a screen view expires and the documents in this screen view are still active, you can still fetch those documents directly from the database by using the API.

How does deleting documents or Brickworks records affect screen view campaigns?

When deleting a document, you will get a warning if it's used in a screen view campaign. If you delete such a document, it will no longer be displayed in the campaign.

When you delete a Brickworks record or schema, you don't get a warning, even if the record or the records of the schema are used in a screen view campaign. To avoid displaying empty content, remove the records from the screen view before you delete them. For details on how deleted records are returned, see Brickworks records in a screen view.