Skip to main content

Alert

Represents a single Alert document.

type Alert {
  id: ID!
  dataset: String!
  class: AlertClass!
  title: String!
  text: String!
  source: String
  value: Float
  variable: String!
  polarity: Int!
  company: AlertCompany
  relatedCompanies: [AlertCompany!]
  payload: JSON!
  resource: AlertResource
  topics: [AlertTopic!]!
  period: String! @deprecated
  publishedAt: String!
  occuredAt: String!
}

Fields​

Alert.id ● ID! non-null scalar​

UUID to identify this Alert document

Alert.dataset ● String! non-null scalar​

Dataset represents type of the source data used to generate this alert

Alert.class ● AlertClass! non-null object​

Class of this Alert, contains machine-frienly "code" as well as human-readable "label" fields.

Alert.title ● String! non-null scalar​

Short summary describing the Alert contents

Alert.text ● String! non-null scalar​

Full text of the Alert

Alert.source ● String scalar​

Represents news source URL for Alerts from the "news" dataset

Alert.value ● Float scalar​

Stores the value of the Alert's dataset at the point when Alert was created

Alert.variable ● String! non-null scalar​

Describes the variable from the dataset which was used to create the Alert

Alert.polarity ● Int! non-null scalar​

Represents the polarity of the signal.

Typical values are: -1 - negative polarity 0 - neutral 1 - positive polarity

Alert.company ● AlertCompany object​

Holds additional data about the Company which this Alert belongs to.

May be "null" in case Alert is related to multiple companies at the same time, when none of them is specifically an Alert target.

For example, a change of the aluminum price may affect many dependent manufacturers, but being a result of overall market movement, rather than an Alert for a specific company.

Contains all the companies related to the parent Alert.

For example, a change of the steel price may affect multiple manufacturers.

When filtering by where.company.id, this list will still contain a full set of companies related to the Alert, not just those with matching IDs (but at least one of them will have a desired ID.)

Alert.payload ● JSON! non-null scalar​

Holds additional metadata related to the specific Alert.

Please, note that the metadata structure varies depending on the Alert's dataset, variable and class.

Alert.resource ● AlertResource object​

Resource that is affected by the given Alert, such as steel, coal, oil, etc. May be missing for Alerts from the datasets that are describing other type of events.

Alert.topics ● [AlertTopic!]! non-null object​

Topics are "tags" associated with a particular Alert. Every Alert belongs to one or more different topics, which you can be subscribed to with Craft.

For example, you can be subscribed to Alerts related to "resource:steel" or "company:429" topics.

All the topics are associated with metadata allowing presentation of the topic in a human-readable way.

Example topics:

  • "dataset:news"
  • "class:awards"
  • "resource:steel"
  • "company:429"
  • "location.country:us"
  • "location.region:asia"

You may filter Alerts by topics using the where.topics boolean expression field that supports "eq", "in" and "like" operators. For example:

{ topics: { eq: "company:429" } } { topics: { in: ["company:429", "company:430"] } } { topics: { startsWith: "company" } }

Alert.publishedAt ● String! non-null scalar​

The date when Alert was validated by Craft

Alert.occuredAt ● String! non-null scalar​

The date of change in the tracked value causing this Alert to be created

Show deprecated

Alert.period ● String! deprecated non-null scalar​

DEPRECATED

Using this field will be always resolved to default

DEPRECATED For timeseries Alerts, defines the time window over which the change of variable was detected

Returned By​

alert query ● alerts query