With the Display Preferences menu, you define how to display your images in the dashboard. You can also add titles, tags, and metrics.
The preferences you set here apply to the currently selected index. They apply to all parts of the dashboard.
These settings apply at the index level, for all users who have access to this index through the dashboard.
How to access the Display Preferences menu
You can access the menu by:
- clicking Display Preferences on the browse index section of the Dashboard,
- clicking on the settings button at the top right of the Visual merchandising screen,
- clicking on the settings button at the top right of the visual editor for rules screen.
Wherever you access the Display Preferences menu, the settings are applied globally across the dashboard.
How to use the Display Preferences menu
The Display Preferences menu contains four tabs: Titles, Metrics, Tags, and Images.
The Titles and Tags tabs, allow you to choose what to display under each image.
- You display the title and one or more subtitles as a line of text. They’re ideal for displaying the name and longer attributes describing your products. Optionally, you can also display a label for your subtitles.
- Tags are small, shaded boxes under the titles. They’re ideal for displaying numbers like price, boolean values, and a single word of information.
The Metrics tab, allows you to define event metrics related to the record, such as Clicks and Conversions. These appear on top of the image.
The Images allows you to define the image attributes, including whether to display an image, and which image to display.
Use this field to define a title for the record. This is commonly the
title attribute of an item.
Subtitle(s) and Add a Label
The subtitles allow you to add additional descriptors to your products, such as a
description attribute, or
You can optionally add a label on the same line of the corresponding subtitle. If you don’t enter a label but your subtitle is not a text (it can be a list, or an object), the subtitle attribute name will be automatically selected as a label.
This will result in:
- if there is no label, your subtitle will be displayed as text
- if there is a label and your subtitle is text
- the label will be displayed on the left side of the card
- the subtitle will be displayed as a text on the right side of the card
- if there is a label and your subtitle is not text
- the label will be displayed on the left side of the card
- an Information icon will be displayed on the right side of the card, with a tooltip to display the subtitle’s content (see tooltip section below for more information).
This lets you add up to three subtitles, each with an optional label.
The Metrics tab allows you to add useful event metrics to your item cards.
Choose whether or not to display this information on your item cards.
Select the metrics you want to display. This might include Number of Clicks, Number of Impressions, or Click Through Rate (ctr). You can add as many metrics as you have data for. Once all metrics have been selected, the + Add Metric option will no longer be visible.
On this tab, you can add small information boxes, which will be displayed at the base of each card.
When clicking on the dropdown menu, you'll be able to select from a list of attributes related to the items in your index.
Tags are commonly used for displaying price, color, brand, category, or other short and useful information.
Define whether to display images, and which attribute should be used for the images.
Display images button
This setting determines whether Algolia should display images or not.
If you don’t have images in your records, you can turn this setting off.
If your images aren’t displaying properly, take a look at the image troubleshooting guide at the bottom of this page.
Tell Algolia which image attribute to use.
If you want to see images, you need to specify the attribute in your index that contains your images. When you send Algolia your data for the first time, Algolia tries to guess the image attribute. However, if it’s unable to, you need to select the correct attribute manually.
Note: if this field is left blank or is populated incorrectly, Algolia won't be able to display your images. Consult your internal technical team for help with this.
Only use this setting if your defined image attribute doesn’t already contain a complete URL. For example, if your image attribute is a partial URL such as
images/123456.jpg, then use the prefix setting to add the
http://www.mywebsite.com/ so Algolia knows where to find the image. Your internal technical team can help you with this.
Only use this setting if your defined image attribute doesn’t contain an extension. For example, if your image attribute is an image name without extension, such as
images/123456, then use the suffix setting to add the
.png at the end. Your internal technical team can help you with this.
Troubleshooting problems with your images
If you’re having problems with your images, check out the following suggestions. Consult your internal technical team for help with this.
Your image attribute is a relative URL
In this case, you need to specify the “Base URL” setting. Example:
Once specified, Algolia re-builds the complete URL:
Your images URLs are blocked
If you have links to images in your records, Algolia needs to fetch them. Make sure your servers, server providers, or CDN aren’t blocking requests from
www.algolia.com with the user agent
Again, because we use a proxy to make the request, and because the proxy is not a web browser, your server may detect that a non-browser is making the request and block it. Please check with your server provider, or your server admin, and ensure that Algolia is not being blocked.
Your records have no image attribute
Deactivate the “Display Images” option. To see images, you need to add an image attribute to your records. Contact the person in your organization who is in charge of importing records and ask them to add an image attribute.
Your images are too large
Internally we have a file size limit of 10MB and an image resolution limit of 20 megapixels. If the URLs lead to images that are larger than this, they will be blocked and not display.
Still not working?
Contact our Support Team here