Alert Object
Alert object represents a single event captured by Craft for a particular company.
Field | Type | Description |
id | ID | UUID to identify this Alert document |
dataset | String! | Dataset represents the type of source data used to generate this alert |
class | ​AlertClass​ | Class of the Alert. Contains machine-friendly "code" as well as human-readable "label" fields. |
title | String! | Summary describing the Alert contents |
text | String! | Full text of the Alert |
source | String | Represents news source URL for Alerts from the "news" dataset |
value | Float | Stores the value of the dataset at the point when Alert was created |
variable | String! | Describes the variable from the dataset which was used to create the Alert |
company | ​AlertCompany​ | Holds additional data about the Company, Alert belongs to |
period | String! | Defines the time window over which the change of variable was detected |
publishedAt | String! | ISO 8601 timestamp when Alert was published by Craft |
occuredAt | String! | ISO 8601 timestamp of change in the tracked value causing this Alert to be created. |
Represents the category of changes that are described by an Alert.
Field | Type | Description |
code | String! | URL-friendly class code |
label | String! | A human-readable version of the Alert's class |
Stores a portion of the data from Basic Company Information for the Company this Alert belongs to.
Field | Type | Description |
id | ID! | Company ID which can be used to query additional Company data from the |
displayName | String! | A human-readable company name. Same as |
homepage | String! | Company's homepage URL. Same as |
