Skip to navigation
Fleet Intelligence — ReferenceAPI Explorerreports

Get error report

View as Markdown

Get error report grouped by error type or node in JSON or CSV format. Default response is JSON. For CSV download (list view only), set format=csv query parameter. Response structure varies based on view and groupBy parameters:

  • When view=list and groupBy=error: The ‘errors’ field is populated with paginated list
  • When view=list and groupBy=node: The ‘nodes’ field is populated with paginated list
  • When view=graph and groupBy=error: Returns time-series data with optional step parameter (page and pageSize not used)
  • When view=overview: Returns aggregate statistics (groupBy parameter not required, page and pageSize not used)

Query parameters

groupByenumOptional

Group by error or node (not required for overview view)

Allowed values:
viewenumRequired

View type: list, graph, or overview

Allowed values:
formatenumOptionalDefaults to json

Response format (json or csv, only for list view)

Allowed values:
pageintegerOptionalDefaults to 0

Page number (0-indexed). Not used for CSV format, graph view, or overview view

pageSizeintegerOptionalDefaults to 10
Page size. Not used for CSV format, graph view, or overview view
stepstringOptional

Query resolution step width in duration format (e.g. 1h, 1m). Only used for graph view. If not provided, backend will choose a suitable step width. Minimum step width is 1 minute.

computeZoneIdslist of stringsOptional
Filter by computezone IDs. Empty means all computezones
nodeGroupIdslist of stringsOptional
Filter by nodegroup IDs. Empty means all nodegroups
tagslist of stringsOptional

Filter by tags (AND logic - matches nodes with ANY of the specified tags). Empty means all nodes

errorslist of stringsOptional

Filter nodes by specific error types (only for list view, groupBy=node). Returns ALL errors for nodes that have any of the specified errors. Examples: ‘NVSwitch Fatal Error’, ‘xid_154’

severitieslist of enumsOptional
Filter errors by severity. Empty means all severities
Allowed values:
timeModestringOptional

Time mode: ‘absolute’ (default) or ‘relative’. Absolute requires start/end; relative requires window

windowstringOptional

Relative time window (e.g., 1h, 1m, 30s). Only used when timeMode=relative

startTimestringOptional

Start time for filtering errors (RFC3339 format). Required when timeMode=absolute

endTimestringOptional

End time for filtering errors (RFC3339 format). Required when timeMode=absolute

Response

Graph response grouped by error (view=graph, groupBy=error)

models.ByErrorResponseobject
OR
models.ByNodeResponseobject
OR
models.ErrorOverviewResponseobject
OR
models.ErrorReportGraphByErrorResponseobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
499
Client Closed Request Error
500
Internal Server Error
503
Service Unavailable Error