Client Errors

Report a dashboard error

Records a failure the dashboard could not recover from, in this installation's own logs. Always answers 202, whether or not the report was kept.

post/api/v1/client-errors

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/client-errors
  • Auth: HTTP bearer

Request body

messagestring required

The error message

stackstring

The JavaScript stack trace, if the browser provided one

componentStackstring

React's component stack, which names the component that threw

urlstring

The page the failure happened on. Its query string is discarded on arrival.

releasestring

The dashboard build that produced the error

Example request

{
  "message": "Cannot read properties of undefined",
  "url": "https://hooks.example.com/admin/deliveries",
  "release": "2.13.0"
}

Response

Report accepted. Whether it was kept depends on the operator's configuration and the per-user rate limit; a page that has already failed can do nothing useful with the difference.

Changes

No recorded changes to this operation across all 1 revision of this API.