Operations at EventsManagement
This page describes the backend methods at this endpoint.
| Signature | Description |
|---|---|
| Void DismissAllAgentAlerts(String agentId) | Marks all alerts for the agent as read, thereby dismissing them from the list of alerts. |
| Void DismissAllCoreAlerts() | Marks all alerts for the core as read, thereby dismissing them from the list of alerts. |
| Void DismissEvent(String eventId) | Marks an event as read, thereby dismissing it from the list of events. |
| AgentAlertSettings GetAgentAlertsSettings(String agentId) | Returns the alert settings for the specified agent such as email content and notification settings. |
| EventSummariesCollection GetCachedEventsByDate(EventsDateRange eventsDateRange) | Gets the summary information for cached events associated with the specified core ordering by date |
| EventsConfiguration GetConfiguration() | Returns configuration information for events such as email content and notification settings. |
| EventDetail GetDetailsForEvent(String eventId) | Gets the details for a single event. |
| EventSummariesCollection GetEvents(EventSearchParameters searchParameters) | Gets collection of events that match to search parameters. The result collection is sorted by UtcTimestamp in descending order. |
| EventSummariesCollection GetEventsByPage(String eventsPerPage, String page, EventSearchParameters searchParameters) | Gets collection of events that match to search parameters, paged for easy viewing in a paged grid. The result collection is sorted by UtcTimestamp in descending order. |
| Int32 GetEventsCount(EventSearchParameters searchParameters) | Gets count of events that match to search parameters. |
| EventTypeGroupInfoCollection GetEventTypes() | Gets the list of all possible event types, organized into groups. |
| Boolean IsEmailTemplateValid(EmailSettings emailSettings) | Checks correctness of email's templates |
| Void SendTestEmail(SendTestEventEmailRequest request) | Generates and sends a test email notification based on the specified email configuration. |
| Void SetAgentAlertsSettings(String agentId, AgentAlertSettings alertSettings) | Sets alert settings for the specified agent such as email content and notification settings. |
| Void SetConfiguration(EventsConfiguration config) | Sets configuration information for events such as email content and notification settings. |