Filter Object

This page specifies all the fields available for filtering in the Alerts API

AlertBoolExpression
This object represents where argument on the alerts node.
Field
Type
Description
id
​IDComparisonExpression​
Allows filtering alerts output by ID of the Alert entities
dataset
​StringComparisonExpression​
Allows filtering Alerts by dataset
class
​AlertClassComparisonExpression​
Allows filtering Alerts by class.code
company
​AlertCompanyComparisonExpression​
Allows filtering Alerts by company.id
publishedAt
​DateComparisonExpression​
Allows chronological filtering of Alerts
IDComparisonExpression
Field
Type
Description
eq
ID
When specified, API will return Alert with this particular id
in
[ID!]
Allows fetching a set of Alerts by a given array of identifiers
StringComparisonExpression
Field
Type
Description
eq
String
Will match values exactly equal to the given one
in
[String!]
Will match values from the given array, using the same comparison as eq operator
nin
[String!]
Inversion of the in operator
AlertClassComparisonExpression
Field
Type
Description
code
StringComparisonExpression
Will match Alerts where the given value matches Alert's class code
AlertCompanyComparisonExpression
Field
Type
Description
id
IDComparisonExpression
Will match Alerts where Company ID matches the given expression
DateComparisonExpression
All the values must be specified using ISO 8601 date or date with time formats.
Field
Type
Description
eq
String
Will match values with a date matching the given value exactly. Please, be aware that "2021-01-01" is equal to "2021-01-01T00:00:00"
neq
String
Inversion of the eq field
gt
String
Will match values greater than given one
gte
String
Will match values greater than or equal to the given one
lt
String
Will match values less than given one
lte
String
Will match values less than or equal to the given one
in
[String!]
Will match values from the given array, using the same comparison as eq operator
nin
[String!]
Inversion of the in field

Alert Object

Order Object

Last updated 1 week ago

Field	Type	Description
id	IDComparisonExpression	Allows filtering `alerts` output by ID of the Alert entities
dataset	StringComparisonExpression	Allows filtering Alerts by `dataset`
class	AlertClassComparisonExpression	Allows filtering Alerts by `class.code`
company	AlertCompanyComparisonExpression	Allows filtering Alerts by `company.id`
publishedAt	DateComparisonExpression	Allows chronological filtering of Alerts