Visual Investigator Alerts

The Visual Investigator Alerts API supports managing alerts in SAS Visual Investigator.

Alerts

The endpoints for managing alerts including creating, updating, retrieval, and deletion.
get
Get alerts
Internal-Use OnlyReturns a collection of alerts based on the specified pagination, filtering, and sorting options./alerts
head
Retrieve alerts
Internal-Use OnlyRetrieves the headers for a collection of alerts based on the specified pagination, filtering, and sorting options./alerts
get
Get an alert
Internal-Use OnlyReturns the alert with the given alert id./alerts/{alertId}
head
Retrieve an alert
Internal-Use OnlyReturns the headers for an alert with the given alert id./alerts/{alertId}
post
Create alert action
Internal-Use OnlyCreates an alert action to perform on an alert. The valid action types are CHECKOUT, CHECKIN, ASSIGNMENT and REACTIVATE. Any other action type results in a 'Bad Request' HTTP status./alerts/{alertId}/alertActions/{actionType}
post
Create an alert disposition
Internal-Use OnlyCreates an action to perform a disposition on an alert./alerts/{alertId}/alertDecisions/{dispositionId}
get
Get alert history action types
Internal-Use OnlyReturns the alert history action types for the given alert./alerts/{alertId}/history/actionTypes
head
Retrieve alert history action types
Internal-Use OnlyRetrieve the headers for the alert history action types for the given alert./alerts/{alertId}/history/actionTypes
get
Get a summary of alert history actions
Internal-Use OnlyReturns the summarized or detailed view of alert history actions for the given alert./alerts/{alertId}/history/actions
head
Retrieve a summary of alert history actions
Internal-Use OnlyRetrieve the headers for the summarized or detailed view of alert history actions for the given alert./alerts/{alertId}/history/actions
get
Get an alert history action
Internal-Use OnlyReturns the detailed alert history action for the given alert./alerts/{alertId}/history/actions/{alertActionSk}
head
Retrieve the alert history action
Internal-Use OnlyRetrieve the headers for the detailed alert history action for the given alert./alerts/{alertId}/history/actions/{alertActionSk}
get
Get alert summaries
Internal-Use OnlyReturns a collection of alert summaries for each version of the alert./alerts/{alertId}/versions
head
Retrieve alert summaries
Internal-Use OnlyRetrieves the headers for a collection of alert summaries, including one summary for each version of the alert./alerts/{alertId}/versions
get
Get scenario-fired events
Internal-Use OnlyReturns the scenario-fired events for the specified alert./alerts/{alertId}/scenarioFiredEvents
head
Retrieve scenario-fired events
Internal-Use OnlyReturns the header for scenario-fired events for the specified alert./alerts/{alertId}/scenarioFiredEvents
get
Get a scorecard for an alert
Internal-Use OnlyReturns a scorecard for the given alert./alerts/{alertId}/scorecard
head
Retrieve a scorecard for an alert
Internal-Use OnlyRetrieves the header for a scorecard for the given alert./alerts/{alertId}/scorecard

Alerting Events

The endpoints for managing alerting events including creating, update, retrieval, and deletion.
post
Create alerting events
Internal-Use OnlyCreates alerting events using a nested or flat representation. If 'batch' is set to TRUE, the alert event is put into a queue to be processed and the job id is returned, otherwise it is created in the request thread./alertingEvents
get
Get a collection of alerting events
Internal-Use OnlyReturns a collection of alerting events based on the specified pagination, filtering, and sorting options./alertingEvents
head
Retrieve a collection of alerting events
Internal-Use OnlyRetrieves the headers for a collection of alerting events based on the specified pagination, filtering, and sorting options./alertingEvents
post
Perform a disposition on an alert
Internal-Use OnlyPerforms disposition on an alert associated with a given alerting event./alertingEvents/{alertingEventId}/alertDecisions/{dispositionId}
get
Get an alerting event
Internal-Use OnlyReturns the representation for the specified alerting event./alertingEvents/{eventId}
head
Retrieve alert existence status
Internal-Use OnlyRetrieves a status to indicate the existence of an alert associated with a specified alerting event./alertingEvents/{eventId}
head
Retrieve alert processing status
Internal-Use OnlyRetrieve a status to indicate if an alert has been processed and is accessible./alertingEvents/{eventId}/alert
get
Get alerting scores
Internal-Use OnlyReturns alerting scores./alertingEvents/{eventId}/scores
head
Retrieve alerting scores
Internal-Use OnlyRetrieves the headers for alerting scores./alertingEvents/{eventId}/scores
get
Get alerting event scorecard
Internal-Use OnlyReturns the scorecard representation for the specified alerting event./alertingEvents/{alertingEventId}/scorecard
head
Retrieve the alerting event scorecard
Internal-Use OnlyRetrieves the headers for the scorecard representation for the specified alerting event./alertingEvents/{alertingEventId}/scorecard

Alert Dispositions

The endpoints for managing alert dispositions including creating, update, retrieval, and deletion.
post
Perform a disposition on a collection of alerts
Internal-Use OnlyPerforms the given disposition on the specified group of alerts./alertDecisions/{dispositionId}
post
Create an alert disposition
Internal-Use OnlyCreates an alert disposition./alertDispositions
get
Get alert dispositions
Internal-Use OnlyReturns alert dispositions./alertDispositions
head
Retrieve alert dispositions
Internal-Use OnlyRetrieves the headers for alert dispositions./alertDispositions
put
Update the alert disposition
Internal-Use OnlyUpdates the given alert disposition./alertDispositions/{dispositionId}
delete
Delete an alert disposition
Internal-Use OnlyDeletes the specified alert disposition./alertDispositions/{dispositionId}
get
Get an alert disposition
Internal-Use OnlyReturns the representation for the specified alert disposition./alertDispositions/{dispositionId}
head
Retrieve the headers for alert disposition
Internal-Use OnlyRetrieves the headers for the specified alert disposition./alertDispositions/{dispositionId}
get
Get an alert disposition request
Internal-Use OnlyReturns an alert disposition request for a given disposition./alertDispositions/{dispositionId}/request
head
Retrieve the alert disposition status
Internal-Use OnlyRetrieve a status indicator of whether the alert disposition has been processed and is accessible./alertDispositions/{dispositionId}/request
post
Create an alert disposition request
Internal-Use OnlyCreates an alert disposition request, where all alerts are in the same given domain./alertDispositions/{dispositionId}/request/{domainId}
head
Retrieve a collection of alert dispositions
Internal-Use OnlyRetrieves a collection of alert dispositions for an alert based on the specified pagination, filtering, and sorting options./alerts/{alertId}/alertDispositions
get
Get alert dispositions
Internal-Use OnlyReturns a list of the alert dispositions for the given alert using a filter./alerts/{alertId}/alertDispositions
get
Get a collection of dispositions
Internal-Use OnlyReturns a collection of alert dispositions for a strategy based on the specified pagination, filtering, and sorting options./strategies/{strategyId}/alertDispositions
head
Retrieve dispositions
Internal-Use OnlyRetrieves the headers for the dispositions for a given strategy./strategies/{strategyId}/alertDispositions

Reports

The endpoints to manage reports for assignments and dispositions.
get
Get a user assignment detail report
Internal-Use OnlyReturns a user assignment detail report./reports/assignment/details
head
Retrieve the user assignment detail report
Internal-Use OnlyRetrieves the header for a user assignment detail report./reports/assignment/details
get
Get a group assignment detail report
Internal-Use OnlyReturns a group assignment detail report./reports/assignment/summary
head
Retrieve a group assignment detail report
Internal-Use OnlyRetrieves the headers for a group assignment detail report./reports/assignment/summary
post
Create a user assignment report
Internal-Use OnlyCreates a user assignment report./reports/assignment/users
get
Get a user assignment report
Internal-Use OnlyReturns a user assignment report./reports/assignment/users/{userId}
head
Retrieve a user assignment report
Internal-Use OnlyRetrieves the headers for the user assignment report./reports/assignment/users/{userId}
post
Create a user assignment hierarchy
Internal-Use OnlyCreates a user assignment hierarchy./reports/assignmentHierarchy/users
get
Get a user assignment hierarchy
Internal-Use OnlyReturns a hierarchy for the user assignment report for the given user./reports/assignmentHierarchy/users/{userId}
head
Retrieve a user assignment report hierarchy
Internal-Use OnlyRetrieves the headers for a user assignment report hierarchy for the given user./reports/assignmentHierarchy/users/{userId}
get
Get a summary hierarchy
Internal-Use OnlyReturns the hierarchy for the summary management reports. The full tree is returned if no user is given./reports/dispositionHierarchy/summary
head
Retrieve a summary hierarchy
Internal-Use OnlyRetrieves the header for a hierarchy of the summary management reports. The full tree is returned if no user is given./reports/dispositionHierarchy/summary
post
Create a user disposition hierarchy
Internal-Use OnlyCreates a user disposition hierarchy./reports/dispositionHierarchy/users
get
Get the user disposition hierarchy
Internal-Use OnlyReturns the user disposition hierarchy for the given user./reports/dispositionHierarchy/users/{userId}
head
Retrieve the user disposition hierarchy
Internal-Use OnlyRetrieves the headers for the user disposition hierarchy for the given user./reports/dispositionHierarchy/users/{userId}
get
Get the disposition history details report
Internal-Use OnlyReturns the disposition history details report./reports/dispositionHistory/details
head
Retrieve the disposition history details report
Internal-Use OnlyRetrieves the headers for a disposition history details report./reports/dispositionHistory/details
get
Get the disposition history summary report
Internal-Use OnlyReturns the disposition history summary report./reports/dispositionHistory/summary
head
Retrieve the disposition history summary report
Internal-Use OnlyRetrieves the headers for a disposition history summary report./reports/dispositionHistory/summary
post
Create the user disposition history report
Internal-Use OnlyCreates the user disposition history report based on a date query./reports/dispositionHistory/users
get
Get the user disposition history report
Internal-Use OnlyReturns the user disposition history report for the given user./reports/dispositionHistory/users/{userId}
head
Retrieve the user disposition history report
Internal-Use OnlyRetrieves the headers for the user disposition history detailed report for the given user./reports/dispositionHistory/users/{userId}

Suppressed Scenarios

The endpoints for retrieving and deleting suppressed scenarios.
get
Get suppressed scenarios
Internal-Use OnlyReturns a collection of suppressed scenarios based on the specified pagination, filtering, and sorting options./suppressedScenarios
head
Retrieve suppressed scenarios
Internal-Use OnlyRetrieves the headers for a collection of suppressed scenarios based on the specified pagination, filtering, and sorting options./suppressedScenarios
post
Create suppressed scenarios
Internal-Use OnlyCreates suppressed scenarios./suppressedScenarios
head
Retrieve a suppressed scenario
Internal-Use OnlyRetrieves the headers for a suppressed scenario./suppressedScenarios/{suppressedScenarioId}
get
Get a suppressed scenario
Internal-Use OnlyReturns the representation for the specified suppressed scenario./suppressedScenarios/{suppressedScenarioId}
delete
Delete a suppressed scenario
Internal-Use OnlyDelete the specified suppressed scenario./suppressedScenarios/{suppressedScenarioId}

Replicated Objects

The endpoints for retrieving replicated objects.
get
Get replicated objects
Internal-Use OnlyReturns replicated objects./replicatedObjects
get
Get a replicated object
Internal-Use OnlyReturns the replicated object with the given replicated object identifier./replicatedObjects/{replicatedObjectId}
head
Retrieve a replicated object
Internal-Use OnlyRetrieve the headers for the replicated object with the given replicated object identifier./replicatedObjects/{replicatedObjectId}
get
Get a replicated object
Internal-Use OnlyReturns the representation for the specified replicated object as an enriched document./replicatedObjects/{replicatedObjectId}/enrichedDocument
head
Retrieve a replicated object
Internal-Use OnlyReturns the headers for the specified replicated object as an enriched document./replicatedObjects/{replicatedObjectId}/enrichedDocument

Scenario Fired Events

Endpoints for retrieving scenario fired events.
get
Get a scenario-fired event
Internal-Use OnlyReturns the scenario-fired event with the specified identifier./scenarioFiredEvents/{sfeId}
head
Get the headers for a scenario-fired event
Internal-Use OnlyReturns the headers for a scenario-fired event with the specified identifier./scenarioFiredEvents/{sfeId}
get
Get contributing objects
Internal-Use OnlyReturns the enriched contributing objects for the scenario-fired event with the specified identifier./scenarioFiredEvents/{sfeId}/contributingObjects
head
Retrieve contributing objects
Internal-Use OnlyRetrieves the headers for enriched contributing objects for the scenario-fired event with the specified identifier./scenarioFiredEvents/{sfeId}/contributingObjects
get
Get a scenario-fired event's enriched replicated objects
Internal-Use OnlyReturns the enriched replicated objects for the scenario-fired event with the specified identifier./scenarioFiredEvents/{sfeId}/replicatedObjects
head
Retrieve the headers for a scenario-fired event's enriched replicated objects
Internal-Use OnlyRetrieves the headers for enriched replicated objects for the scenario-fired event with the specified identifier./scenarioFiredEvents/{sfeId}/replicatedObjects

Scenarios

The endpoints for retrieving scenario dispositions.
get
Get scenario dispositions
Internal-Use OnlyReturns a collection of scenario dispositions by identifier./scenario/{scenarioId}/scenarioDispositions
head
Retrieve a collection of scenario dispositions
Internal-Use OnlyRetrieve the headers for a collection of scenario dispositions by id./scenario/{scenarioId}/scenarioDispositions
get
Get a collection of scenario dispositions
Internal-Use OnlyReturns a collection of scenario dispositions using a standard filter./scenarioDispositions
head
Retrieve a collection of scenario dispositions
Internal-Use OnlyRetrieves the headers for a collection of scenario dispositions using a standard filter./scenarioDispositions
post
Create a scenario disposition summary
Internal-Use OnlyCreates a scenario disposition summary./scenarioDispositions/summaries

Strategies

The endpoints for creating, updating, upserting, retrieving, and deleting strategies.
post
Create a strategy
Internal-Use OnlyCreates or updates a strategy./strategies
get
Get strategies
Internal-Use OnlyReturns strategies based on a standard filter./strategies
put
Update a strategy
Internal-Use OnlyUpdates the strategy with the given strategy identifier./strategies/{strategyId}
delete
Delete a strategy
Internal-Use OnlyDeletes the strategy with the given strategy identifier./strategies/{strategyId}
get
Get a strategy
Internal-Use OnlyRetrieves the strategy with the given strategy identifier./strategies/{strategyId}
head
Retrieve a strategy
Internal-Use OnlyRetrieves the headers for a strategy with the given strategy identifier./strategies/{strategyId}
post
Create a collection of alerts
Internal-Use OnlyCreates a collection of alerts from a given strategy using a filter./strategies/{strategyId}/alerts
get
Return a collection of alerts
Internal-Use OnlyReturns a collection of alerts with a given strategy identifier./strategies/{strategyId}/alerts
head
Retrieve a collection of alerts
Internal-Use OnlyRetrieves the headers for a collection of alerts with a given strategy identifier./strategies/{strategyId}/alerts
get
Return a collection of active scenario fired events
Internal-Use OnlyReturns a collection of scoring scenario fired events with a given strategy identifier./strategies/{strategyId}/scenarioFiredEvents
head
Return a collection of active scenario fired events
Internal-Use OnlyReturns a collection of scoring scenario fired events with a given strategy identifier./strategies/{strategyId}/scenarioFiredEvents
get
Get a collection of scenarios
Internal-Use OnlyGet a collection of scenarios with a given strategy identifier./strategies/{strategyId}/scenarios
head
Retrieve a collection of scenarios
Internal-Use OnlyRetrieves the headers for a collection of scenarios with a given strategy identifier./strategies/{strategyId}/scenarios

Logic Expressions

The endpoints for creating, updating, upserting, retrieving, and deleting logic expressions.
post
Create a logic expression
Internal-Use OnlyCreates or updates a logic expression./logicExpressions
get
Get a logic expression
Internal-Use OnlyReturns a logic expression based on a standard filter./logicExpressions
put
Update a logic expression
Internal-Use OnlyUpdates the logic expression with the given logic expression identifier./logicExpressions/{logicExpressionId}
delete
Delete a logic expression
Internal-Use OnlyDeletes a logic expression with a given logic expression identifier./logicExpressions/{logicExpressionId}
get
Get a logic expression
Internal-Use OnlyReturns a logic expression with the given identifier./logicExpressions/{logicExpressionId}
head
Retrieve a logic expression
Internal-Use OnlyRetrieves headers for a logic expression with the given identifier./logicExpressions/{logicExpressionId}

Domains

The endpoints for creating, updating, upserting, retrieving, and deleting domains.
post
Create a domain
Internal-Use OnlyCreates or updates a domain./domains
get
Get domains
Internal-Use OnlyReturns domains using a standard filter./domains
put
Update a domain
Internal-Use OnlyUpdates the domain with the given domain identifier./domains/{domainId}
delete
Delete a domain
Internal-Use OnlyDeletes the domain with the given domain identifier./domains/{domainId}
get
Get a domain
Internal-Use OnlyReturns the domain with the given domain identifier./domains/{domainId}
head
Retrieve a domain
Internal-Use OnlyRetrieves the headers for the domain with the given domain identifier./domains/{domainId}
get
Get queues by domain
Internal-Use OnlyReturns queues associated with the given domain using a standard filter./domains/{domainId}/queues
head
Retrieve queues by domain
Internal-Use OnlyRetrieves the headers for queues associated with the given domain using a standard filter./domains/{domainId}/queues
get
Get scenario tags by domain
Internal-Use OnlyGet scenario tags associated with the given domain using a standard filter./domains/{domainId}/scenarioTags
head
Retrieve scenario tags by domain
Internal-Use OnlyRetrieves the headers for scenario tags associated with the given domain using a standard filter./domains/{domainId}/scenarioTags
get
Get strategies by domain
Internal-Use OnlyGet strategies associated with the given domain using a standard filter./domains/{domainId}/strategies
head
Retrieve strategies by domain
Internal-Use OnlyRetrieve the headers for strategies associated with the given domain and using a standard filter./domains/{domainId}/strategies

Scenario Tags

The endpoints for creating, updating, upserting, and retrieving scenario tags.
post
Create a scenario tag
Internal-Use OnlyCreate or update a scenario tag./scenarioTags
get
Get scenario tags
Internal-Use OnlyReturns scenario tags using a standard filter./scenarioTags
put
Update a scenario tag
Internal-Use OnlyUpdates a scenario tag based on the given identifier./scenarioTags/{scenarioTagId}
delete
Delete a scenario tag (Deprecated)
Internal-Use OnlyThis method is now deprecated and should no longer be used./scenarioTags/{scenarioTagId}
get
Get a scenario tag
Internal-Use OnlyReturns the scenario tag with the given identifier./scenarioTags/{scenarioTagId}
head
Retrieve a scenario tag
Internal-Use OnlyRetrieves the header for the scenario tag with the given identifier./scenarioTags/{scenarioTagId}

Metrics

The endpoints for retrieving metrics.
get
Get queue metrics
Internal-Use OnlyReturns today's queue metrics for a given strategy./strategies/{strategyId}/queues/metrics
head
Retrieve queue metrics
Internal-Use OnlyRetrieves the headers for today's queue metrics for a given strategy./strategies/{strategyId}/queues/metrics
get
Get alert metrics
Internal-Use OnlyReturns today's alert metrics./users/{id}/alerts/metrics
head
Retrieve alert metrics
Internal-Use OnlyRetrieves the headers for today's alert metrics./users/{id}/alerts/metrics
get
Get strategy metrics
Internal-Use OnlyRetrieve today's strategy metrics for the current user and domain./users/{id}/domains/{domainId}/strategies/metrics
head
Retrieve strategy metrics
Internal-Use OnlyRetrieves the headers for today's strategy metrics for the current user and domain./users/{id}/domains/{domainId}/strategies/metrics
get
Get personal metrics
Internal-Use OnlyReturns personal metrics for a given user./users/{user_id}/strategies/metrics
head
Retrieve personal metrics
Internal-Use OnlyRetrieves the headers for personal metrics for a given user./users/{user_id}/strategies/metrics
get
Get personal metrics by strategy
Internal-Use OnlyReturns personal metrics for a given user and strategy./users/{user_id}/strategies/{strategy_id}/metrics
head
Retrieve personal metrics by strategy
Internal-Use OnlyRetrieves the headers for personal metrics for a given user and strategy./users/{user_id}/strategies/{strategy_id}/metrics