The Delivery API provides several filters to help you refine your requests based on your requirements. To choose the right one, think about what you know about the content you want to get. There’s a filter for every use case.Find a scenario relevant to you and adjust the code samples to get the content you need.
To get an item based on its identifier (like ID or codename), use the equals filter. For example, if you need to get an item by its internal ID, you match the item's ID (found in system.id) against the ID value you have.
To get items by a datetime value, you can use one of the comparison filters. This lets you retrieve content modified or released before or after a certain date. The following code shows the filters used on the last content modification date and a date & time element
.
To get items based on the value of a text or rich text
The URL slug element value is stored in the same way as the values of text elements. This means the approach to getting items by a specific URL slug is the same, using the equals filter.
element, you need to specify the value using the equals filter.
Filter by where items are used – You can have a linked items element for navigation. Each linked item represents a navigation item in a hierarchy.
Filter by article's author – You can have several articles written by a single author, Jane. Each article has a linked items element named Author, containing a reference to the content item that represents the author Jane.
Sign in with your Kontent.ai credentials or sign up for free to unlock the full lesson, track your progress, and access exclusive expert insights and tips!
If you have multiple codenames of a single type and want to retrieve the items in a single request, use GraphQL aliases.
To get items based on a single content type, use the root collection query for a specific type, for example, product_All.
To get items based on multiple content types, specify multiple root collection queries.
To get items tagged with specific taxonomy terms, you need to specify the terms using either the containsAny or containsAll filters.
GraphQL
# Gets an item by its internal IDquery GetArticleById { article_All(where: {_system_: {id: {eq: "2f7288a1-cfc8-47be-9bf1-b1d312f7da18"}}}) { items { title } }}
GraphQL
# Gets three articles by their codenames. Use GraphQL aliases to retrieve multiple items of the same type.query GetArticlesByCodenames { helloWorldArticle: article(codename: "hello_world") { title } getContentArticle: article(codename: "get_content") { title } filterContentArticle: article(codename: "filter_content") { title }}
GraphQL
# Gets items based on the type Productquery GetItemsByType { product_All { # Root collection query specifies the content type items { price } }}
GraphQL
# Gets items based on the types Product, Article, and Newsquery GetItemsByTypes { product_All { # Root collection query for Product means you'll get items based on the Product content type items { name } } article_All { # Root collection query for Article means you'll get items based on the Article content type items { title } } news_All { # Root collection query for News means you'll get items based on the News content type items { title } }}
GraphQL
# Gets articles modified after November 1 2021, 9 am UTC+0query GetArticlesModifiedAfterDate { article_All (where: {_system_: {lastModified: {gt: "2021-11-01T09:00:00Z"}}}) { items { title } }}# Gets articles released at or after November 1 2021, 9 am UTC+0query GetArticlesReleasedAfterDate { article_All (where: {releaseDate: {gte: "2021-11-01T09:00:00Z"}}) { items { title } }}# Gets articles modified before November 1 2021, 12 pm UTC+0. Last match would be at 2021-10-31T:11:59:59query GetArticlesModifiedBeforeDate { article_All (where: {_system_: {lastModified: {lt: "2021-11-01T00:00:00Z"}}}) { items { title } } }# Gets articles released at or before November 1 2021, 9 am UTC+0query GetArticlesReleasedAfterDate { article_All (where: {releaseDate: {lte: "2021-11-01T09:00:00Z"}}) { items { title } }}
GraphQL
# Gets articles whose Title element value equals to "Hello World"query GetArticleByTitle { article_All(where: {title: {eq: "Hello World"}}) { items { title } }}
GraphQL
# Note: Filters work with codenames. This means codenames of the taxonomy terms or multiple choice options.# Gets items tagged with one specific tagquery GetArticlesTaggedWithATerm { article_All(where: {topic: {containsAny: ["kontent_ai"]}}) { items { title } }}# Gets items tagged with a list of specific tagsquery GetArticlesTaggedWithTerms { article_All(where: {topic: {containsAll: ["kontent_ai", "cms"]}}) { items { title } }}# Gets items tagged with at least one tag from the listquery GetArticlesTaggedWithOneOfTerms { article_All(where: {topic: {containsAny: ["headless", "cms"]}}) { items { title } }}
Tip: This approach works equally well for other system properties of the content item object. For example, system.workflow_step, system.collection, system.last_modified.
Filter content to get what you need | Kontent.ai Learn