RestApiCategories.visualInvestigator.desc

visual_investigator

2025.12

2026.01

2026.02

2026.03

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

Visual Investigator Alerts

2025.09

Retrieves the headers for today's alert metrics.

Specifies the current date in UTC at midnight of the local users time zone offset (for example, August 28th 2016 @ 9:00 PM EST -&gt; 2016-08-29T01:00:00Z)

today

Specifies whether to include queues metrics in the result (default is true).

includeQueues

responseEntity

Specifies the content type of the response.

Content-Type

An example of an input validation failure response.

A schema of the generic validation failed response by input validation.

validationFailure

Specifies an example URL including the base path for this API.

Retrieve alert metrics

actionRequest

A collection of action request representations.

actionRequestCollectionRep

actionRequestRep

actionResponseRep

An Active scenario-fired event representation.

activeScenarioFiredEventRep

Alert Representation Collection

A collection of alert version summary representations.

Alert Version Summary Rep Collection

alertDispositionRep

A collection of alerting event field description representations.

Alerting Event Field Description Rep Collection

A collection of alerting event nested representations.

Alerting Event Nested Rep Collection

A collection of alerting event representations.

Alerting Event Rep Collection

An alerting data representation in the flat format.

alertingDataFlatRep

An alerting data representation in the nested format.

alertingDataNestedRep

An alerting event field description representation.

alertingEventFieldDescriptionRep

alertingEventInFlatAlertingDataRep

alertingEventInNestedAlertingDataRep

An alerting event representation in the nested format.

alertingEventNestedRep

alertingEventRep

alertRep

A contributing object flag representation.

alertVersionSummaryRep

baseCollection2

Specifies a ZIP file that represents the scorecard service's configuration.

Configuration Object

A contributing object flag representation in the flat format.

contributingObjectFlatRep

contributingObjectRep

dataField

A detailed history action representation.

detailedHistoryAction

A collection of disposition response representations.

Disposition Response Rep Collection

dispositionqueueRep

dispositionRequest

dispositionResponseRep

A collection of domain node representations.

Domain Node Rep Collection

Domain Rep Collection

domainNode

domainRep

A collection of enriched document representations.

Enriched Document Rep Collection

enrichedDocument

An enriched document wrapper representation.

enrichedDocumentWrapper

A collection of enrichment field representations.

Enrichment Field Collection

enrichmentFieldRep

entityHandle

entityScenariosRep

entityStyleDTO

A schema of the standard error format for the alert service.

error2

A collection of extended scenario-fired event representations.

Extended Scenario Fired Event Rep Collection

An extended scenario-fired event representation.

extendedScenarioFiredEventRep

An object containing a details of a failed scenario-fired event disposition.

failedDispositionRep

A collection of field description representations.

Field Description Rep Collection

fieldDescriptionRep

fieldValues

fileCategory

A filtered for user query representation.

filteredForUserQueryRep

A group user assignment report representation.

groupUserAssignmentReport

groupUserReport

A collection of history action type representations.

History Action Type Rep Collection

historyActionDetails

historyActionType

An ID representation. This value will be null if there is no job created for the Alert Generation Process.

jobIdRep

Link

localizedDescription

localizedLabel

A collection of logic expression representations.

Logic Expression Rep Collection

logicExpressionRep

Queue Rep Collection

queueNode

queueRep

relationship

A collection of replicated objects representations.

Replicated Object Rep Collection

replicatedObjectRep

A collection of report user query representations.

Report User Query Rep Collection

reportUserDateQueryRep

A report user details date query representation.

reportUserDetailsDateQueryRep

A report user details query representation.

reportUserDetailsQueryRep

reportUserQueryRep

A collection of routing rule representations.

Routing Rule Rep Collection

routingRuleRep

A collection of scenario disposition representations.

Scenario Disposition Rep Collection

A collection of scenario fired event field description representations.

Scenario Fired Event Description Rep Collection

A collection of scenario representations.

Scenario Representation Collection

A collection of Scenario Tag representations.

Scenario Tag Collection

scenarioDispositionRep

A scenario disposition summary representation.

scenarioDispositionSummaryRep

A scenario disposition summary request representation.

scenarioDispositionSummaryRequestRep

An object containing a collection of scenario-fired event disposition representations and failed scenario-fired event disposition representations

Name	Type	Required	Description
includeQueues	boolean	false	Specifies whether to include queues metrics in the result (default is true). Default: true
today	string	true	Specifies the current date in UTC at midnight of the local users time zone offset (for example, August 28th 2016 @ 9:00 PM EST -> 2016-08-29T01:00:00Z) <= 100 characters

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema

Retrieve alert metrics

Request Samples

Path Parameters

Query Parameters

Responses