Request an API keyBack to Craft.co
Search…
Introduction
About GraphQL
Authentication
Troubleshooting
Company Data API
Company Data API Introduction
Getting started
Query Parameters
Data Categories
GraphQL Enums
Core data types
Query examples
Restrictions on Usage
Usage
Added Companies API
Newly Profiled Companies API Introduction
Query
Alerts API
Alerts API Introduction
Getting started
Alerts API Queries
Alerts API Reference
Alert Object
Filter Object
Order Object
Payload Object
Query examples
Restrictions on Usage
Powered By GitBook
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
Allows filtering Alerts by dataset
class
Allows filtering Alerts by class.code
company
Allows filtering Alerts by company.id or relatedCompanies.id (with logical "OR"). Alerts with relatedCompanies will be matched if any of the relatedCompanies matches the given comparison expression
resource
Allows filtering Alerts by resource.id and resource.type
polarity
​IntComparisonExpression​
Allows filtering Alerts by the value of polarity field
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

IntComparisonExpression

Field
Type
Description
eq
Int
Will match values exactly equal to the given one
neq
Int
Will match values that are strictly not equal to the given one
gt
Int
Will match values that are greater than the given one
gte
Int
Will match values that are greater or equal to the given one
lt
Int
Will match values that are less than the given value
lte
Int
Will match values that are less than or equal to the given one
in
[Int!]
Will match values from the given array, using the same comparison as eq operator
nin
[Int!]
Inversion of the in operator
isNull
Boolean
Will match values testing their equality to null

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

AlertResourceComparisonExpression

Field
Type
Description
id
StringComparisonExpression
Will match Alerts where Resource ID matches the given expression
type
StringComparisonExpression
Will match Alerts where Resource Type 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
Previous
Alert Object
Next
Order Object
Last modified 1mo ago
Copy link
Contents
AlertBoolExpression
IDComparisonExpression
StringComparisonExpression
IntComparisonExpression
AlertClassComparisonExpression
AlertCompanyComparisonExpression
AlertResourceComparisonExpression
DateComparisonExpression