You can supply different parameters to the filter
argument to filter the query response accordingly. The available options depend on the fields defined on the model in question.
If you supply exactly one parameter to the filter argument, the query response will only contain records that fulfill this constraint:
query {allArtists(filter: {published: { eq: false }}) {idnamepublished}}
Depending on the type of the field you want to filter by, you have access to different advanced criteria you can use to filter your query response:
query {allArtists(filter: {name: { in: [ "Blank Banshee", "Gazelle Twin" ] }}) {idnamegenre}}
If you specify multiple conditions, they will be combined as if it was a logical AND expression:
query {allAlbums(filter: {{ artist: { eq: "212" } },{ releaseDate: { gt: "2016-01-01" } }}) {idslugartist { name }coverImage { url }}}
There are times where it can be more convenient to use an AND expression explicitly, for example when you need to use the same type of filter more than once:
query {allArtists(filter: {AND: [{ name: { matches: { pattern: "Blank"} },{ name: { matches: { pattern: "Banshee"} }]}) {idnamegenre}}
It is also possible to combine AND-like and OR logical expressions. For example, the following query will return all the point of interest located in New York that either have a rating greater than 4 or are a restaurant:
query {allPois(filter: {address: { matches: { pattern: "new york" } },OR: [{ rating: { gt: 4 } },{ name: { matches: { pattern: "restaurant" } } },]}) {nameaddressrating}}
If a Structured Text field has the deep filtering option enabled, its filters will slightly differ from the ones described in this page. You learn more in the next section of the doc regarding deep filtering.
query {allProducts(filter: { booleanField: { eq: true } }) {title}}
query {allProducts(filter: { colorField: { exists: true } }) {title}}
query {allProducts(filter: { dateField: { gt: "2018-02-13" } }) {title}}
query {allProducts(filter: { dateField: { lt: "2018-02-13" } }) {title}}
query {allProducts(filter: { dateField: { gte: "2018-02-13" } }) {title}}
query {allProducts(filter: { dateField: { lte: "2018-02-13" } }) {title}}
query {allProducts(filter: { dateField: { exists: true } }) {title}}
query {allProducts(filter: { dateField: { eq: "2018-02-13" } }) {title}}
query {allProducts(filter: { dateField: { neq: "2018-02-13" } }) {title}}
query {allProducts(filter: {dateTimeField: {gt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {dateTimeField: {lt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {dateTimeField: {gte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {dateTimeField: {lte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {dateTimeField: {eq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {dateTimeField: {neq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: { dateTimeField: { exists: true } }) {title}}
query {allProducts(filter: { fileField: { eq: "123" } }) {title}}
query {allProducts(filter: { fileField: { neq: "123" } }) {title}}
query {allProducts(filter: { fileField: { in: ["123"] } }) {title}}
query {allProducts(filter: { fileField: { notIn: ["123"] } }) {title}}
query {allProducts(filter: { fileField: { exists: true } }) {title}}
query {allProducts(filter: { floatField: { gt: 19.99 } }) {title}}
query {allProducts(filter: { floatField: { lt: 19.99 } }) {title}}
query {allProducts(filter: { floatField: { gte: 19.99 } }) {title}}
query {allProducts(filter: { floatField: { lte: 19.99 } }) {title}}
query {allProducts(filter: { floatField: { exists: true } }) {title}}
query {allProducts(filter: { floatField: { eq: 19.99 } }) {title}}
query {allProducts(filter: { floatField: { neq: 19.99 } }) {title}}
query {allProducts(filter: { galleryField: { eq: ["123"] } }) {title}}
query {allProducts(filter: { galleryField: { allIn: ["123"] } }) {title}}
query {allProducts(filter: { galleryField: { anyIn: ["123"] } }) {title}}
query {allProducts(filter: { galleryField: { notIn: ["123"] } }) {title}}
query {allProducts(filter: { galleryField: { exists: true } }) {title}}
query {allProducts(filter: { integerField: { gt: 3 } }) {title}}
query {allProducts(filter: { integerField: { lt: 3 } }) {title}}
query {allProducts(filter: { integerField: { gte: 3 } }) {title}}
query {allProducts(filter: { integerField: { lte: 3 } }) {title}}
query {allProducts(filter: { integerField: { exists: true } }) {title}}
query {allProducts(filter: { integerField: { eq: 3 } }) {title}}
query {allProducts(filter: { integerField: { neq: 3 } }) {title}}
query {allProducts(filter: { jsonField: { exists: true } }) {title}}
query {allProducts(filter: {latLonField: {near: { latitude: 40.73, longitude: -73.93, radius: 10 }}}) {title}}
query {allProducts(filter: { latLonField: { exists: true } }) {title}}
query {allProducts(filter: { linkField: { eq: "123" } }) {title}}
query {allProducts(filter: { linkField: { neq: "123" } }) {title}}
query {allProducts(filter: { linkField: { in: ["123"] } }) {title}}
query {allProducts(filter: { linkField: { notIn: ["123"] } }) {title}}
query {allProducts(filter: { linkField: { exists: true } }) {title}}
query {allProducts(filter: { linksField: { eq: ["123"] } }) {title}}
query {allProducts(filter: { linksField: { allIn: ["123"] } }) {title}}
query {allProducts(filter: { linksField: { anyIn: ["123"] } }) {title}}
query {allProducts(filter: { linksField: { notIn: ["123"] } }) {title}}
query {allProducts(filter: { linksField: { exists: true } }) {title}}
query {allProducts(filter: { seoField: { exists: true } }) {title}}
query {allProducts(filter: { slugField: { eq: "bike" } }) {title}}
query {allProducts(filter: { slugField: { neq: "bike" } }) {title}}
query {allProducts(filter: { slugField: { in: ["bike"] } }) {title}}
query {allProducts(filter: { slugField: { notIn: ["bike"] } }) {title}}
query {allProducts(filter: {stringField: {matches: { pattern: "bi(cycl|k)e", caseSensitive: false }}}) {title}}
query {allProducts(filter: {stringField: {notMatches: { pattern: "bi(cycl|k)e", caseSensitive: false }}}) {title}}
query {allProducts(filter: { stringField: { isBlank: true } }) {title}}
query {allProducts(filter: { stringField: { isPresent: true } }) {title}}
query {allProducts(filter: { stringField: { eq: "bike" } }) {title}}
query {allProducts(filter: { stringField: { neq: "bike" } }) {title}}
query {allProducts(filter: { stringField: { in: ["bike"] } }) {title}}
query {allProducts(filter: { stringField: { notIn: ["bike"] } }) {title}}
query {allProducts(filter: { stringField: { exists: true } }) {title}}
query {allProducts(filter: {textField: {matches: { pattern: "bi(cycl|k)e", caseSensitive: false }}}) {title}}
query {allProducts(filter: {textField: {notMatches: { pattern: "bi(cycl|k)e", caseSensitive: false }}}) {title}}
query {allProducts(filter: { textField: { isBlank: true } }) {title}}
query {allProducts(filter: { textField: { isPresent: true } }) {title}}
query {allProducts(filter: { textField: { exists: true } }) {title}}
query {allProducts(filter: { videoField: { exists: true } }) {title}}
query {allProducts(filter: {structuredTextField: {matches: { pattern: "bi(cycl|k)e", caseSensitive: false }}}) {title}}
query {allProducts(filter: {structuredTextField: {notMatches: { pattern: "bi(cycl|k)e", caseSensitive: false }}}) {title}}
query {allProducts(filter: { structuredTextField: { isBlank: true } }) {title}}
query {allProducts(filter: { structuredTextField: { isPresent: true } }) {title}}
query {allProducts(filter: { structuredTextField: { exists: true } }) {title}}
_createdAt
meta field query {allProducts(filter: {_createdAt: {gt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_createdAt: {lt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_createdAt: {gte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_createdAt: {lte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_createdAt: {eq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_createdAt: {neq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: { _createdAt: { exists: true } }) {title}}
id
meta field query {allProducts(filter: { id: { eq: "123" } }) {title}}
query {allProducts(filter: { id: { neq: "123" } }) {title}}
query {allProducts(filter: { id: { in: ["123"] } }) {title}}
query {allProducts(filter: { id: { notIn: ["123"] } }) {title}}
_firstPublishedAt
meta field query {allProducts(filter: {_firstPublishedAt: {gt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_firstPublishedAt: {lt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_firstPublishedAt: {gte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_firstPublishedAt: {lte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_firstPublishedAt: {eq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_firstPublishedAt: {neq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: { _firstPublishedAt: { exists: true } }) {title}}
parent
meta field query {allProducts(filter: { parent: { eq: "123" } }) {title}}
query {allProducts(filter: { parent: { exists: true } }) {title}}
position
meta field query {allProducts(filter: { position: { gt: 3 } }) {title}}
query {allProducts(filter: { position: { lt: 3 } }) {title}}
query {allProducts(filter: { position: { gte: 3 } }) {title}}
query {allProducts(filter: { position: { lte: 3 } }) {title}}
query {allProducts(filter: { position: { eq: 3 } }) {title}}
query {allProducts(filter: { position: { neq: 3 } }) {title}}
_publicationScheduledAt
meta field query {allProducts(filter: {_publicationScheduledAt: {gt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_publicationScheduledAt: {lt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_publicationScheduledAt: {gte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_publicationScheduledAt: {lte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_publicationScheduledAt: {eq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_publicationScheduledAt: {neq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: { _publicationScheduledAt: { exists: true } }) {title}}
_unpublishingScheduledAt
meta field query {allProducts(filter: {_unpublishingScheduledAt: {gt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_unpublishingScheduledAt: {lt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_unpublishingScheduledAt: {gte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_unpublishingScheduledAt: {lte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_unpublishingScheduledAt: {eq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_unpublishingScheduledAt: {neq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: { _unpublishingScheduledAt: { exists: true } }) {title}}
_publishedAt
meta field query {allProducts(filter: {_publishedAt: {gt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_publishedAt: {lt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_publishedAt: {gte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_publishedAt: {lte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_publishedAt: {eq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_publishedAt: {neq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: { _publishedAt: { exists: true } }) {title}}
_status
meta field query {allProducts(filter: { _status: { eq: draft } }) {title}}
query {allProducts(filter: { _status: { neq: draft } }) {title}}
query {allProducts(filter: { _status: { in: [draft] } }) {title}}
query {allProducts(filter: { _status: { notIn: [draft] } }) {title}}
_updatedAt
meta field query {allProducts(filter: {_updatedAt: {gt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_updatedAt: {lt: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_updatedAt: {gte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_updatedAt: {lte: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_updatedAt: {eq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: {_updatedAt: {neq: "2018-02-13T14:30:00+00:00"}}) {title}}
query {allProducts(filter: { _updatedAt: { exists: true } }) {title}}
_isValid
meta field query {allProducts(filter: { _isValid: { eq: true } }) {title}}