Announcements > Breaking Change for Article Tag Filtering

Breaking Change for Article Tag Filtering

When you include an inbox unit in your email template, there is an optional parameter for adding query strings and/or filters for the content that is returned. This is something that you send in as part of the code snippet you include in your email templates, and is something that you can edit and change per mailing.

In addition to being able to do free-text queries, you can do per-field searches. One of those fields lets you specifically search HTML meta-tags that are on your pages.We have improved the way that we index and search for page meta tags in our InBox units.

Below is a summary and examples of the change

EXAMPLE

Lets say you have a set of meta tags in your HTML markup called article:tag, for example you might have the following in one of your pages HTML code:

HTML
<meta property="article:tag" content="running" />

In this example, article:tag is referred to as the key and running is referred to as the value of this meta-tag

The examples below show both the old way (v1) of filtering and also the new updated way (v2) of filtering for meta tag values

v1 : OLD WAY of filtering on meta tags in queries

HTML
metaTags:"article:tag:running"

In v1 you could search and/or filter on a field called metaTags, meta-tag key-value pairs are indexed as a single string in this. In this example the field we search is metaTags and the value we search for is “article:tag:running”

v2 : NEW WAY of filtering on meta tags in queries

HTML
meta.article\:tag:running

There is now a field called meta with subfield for each meta-tag keys and values indexed separately. In this example the field we search s meta.article\:tag and the value is running. (the colon is a special character for queries, which is why is is escaped with a backslash)

Why this is better

Having keys and values indexed separately means that we can analyze/clean-up meta tag values (so we can do case insensitive-queries for instance), we can also do better searches/filters for non-string fields, such as numbers/dates (we can do greater-than, less-than, or range queries, which we could not do with the old format). This also makes it possible to build analysis tools that can tell you things like the top meta-tag values for a certain key (i.e. what are the top article-tags in our content library). If the future, these capabilities will be exposed in our content browser and insights tools.

THIS IS A BREAKING CHANGE – What this means

The new meta tag search and filtering format (v2) is live and available for use today. We will be turning off the old metaTags field (v1) for recommendation filtering on April 30th, 2018. Which means that any queries/filters that are sent in after this date which use the v1 syntax will no longer work.

We have verified that existing no InBox units that are currently configured or in-flight will break or need to be updated. However, if you develop any InBox units in the future that require filtering or searching on meta-tags, you will need to use the v2 format since the v1 filters will not longer work.