Get Events by Filter

get

/vision/api/rawEvents/filtered

Gets all events that the requesting user has access to. You can optionally filter the results by providing query parameters.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:
  • Admin
  • Operator
  • Viewer
  • Api

Request

Query Parameters
  • The entities to filter the results by. You can optionally include the zone ID in the format <entityName>;z<zoneID>. If you do not include the zone ID, the default zone (1) is used.
    Example:
    entity123,entity456;z2
  • The interfaces to filter the results by.
    Example:
    interface123,interface456
  • The layer to filter the results by.
    Example:
    STE Events
  • The marker types to filter the results by.
    Example:
    dDevice,pLink

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ResourceWrapper41
Type: object
The response resource wrapper.
Show Source
Nested Schema : columns
Type: array
Information about the columns used to display the requested or updated content.
Show Source
Nested Schema : content
Type: array
The requested or updated content.
Show Source
Nested Schema : ColumnData
Type: object
The details of columns to use to show data in a table.
Show Source
Nested Schema : RawEvent
Type: object
The raw event details.
Show Source
Nested Schema : metadata
Type: object
Metadata for the event.
Example:
type: dDevice

401 Response

Unauthorized Access
Body ()
Root Schema : schema
Type: object
The error response details.
Show Source

500 Response

An internal server error occurred while accessing the database or performing a database operation.
Body ()
Root Schema : schema
Type: object
The error response details.
Show Source
Back to Top