Events
Retrieves a list of events associated with the shop.
View-Specific Information
Select
The server processes all filters client-side within the server. The following query is the only one processed server-side:
SELECT * FROM Events
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| AppTitle | String | The name of the app that created the event. | |
| AttributeToApp | Bool | Whether the event was created by an app. | |
| AttributeToUser | Bool | Whether the event was caused by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Whether the event is critical. | |
| Action | String | The action that occurred. | |
| Message | String | Human readable text that describes the event. | |
| BasicEventSubjectId | String | The ID of the resource that generated the event. | |
| BasicEventSubjectType | String | The type of the resource that generated the event. | |
| BasicEventHasAdditionalContent | Bool | Whether this event has additional content. | |
| BasicEventAdditionalContent | String | Provides additional content for collapsible timeline events. | |
| BasicEventAdditionalData | String | Provides additional data for event consumers. | |
| BasicEventSecondaryMessage | String | Human readable text that supports the event message. | |
| BasicEventArguments | String | Refers to a certain event and its resources. | |
| CommentEventAuthorId | String | The id of the staff member that authored the comment event. | |
| CommentEventCanDelete | Bool | Whether the comment event can be deleted. If true, then the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Whether the comment event can edited. If true, then the comment event can be edited. | |
| CommentEventEdited | Bool | Whether the comment event has been edited. If true, then the comment event has been edited. | |
| CommentEventRawMessage | String | The raw body of the comment event. | |
| CommentEventSubjectId | String | The parent subject to which the comment event belongs. | |
| CommentEventSubjectHasTimelineComment | Bool | Whether the timeline subject has a timeline comment. If true, then a timeline comment exists. | |
| CommentEventEmbedCustomerId | String | The object reference associated with the comment event. | |
| CommentEventEmbedDraftOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedOrderId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductId | String | The object reference associated with the comment event. | |
| CommentEventEmbedProductVariantId | String | The object reference associated with the comment event. |