TRMNL Octri Demo
POST/api/analytics/hidden_errors

Hide an author plugin error row from analytics

Hides an author plugin error row from analytics. Provide kind, subject_id, owner, and message from a row returned by the plugin error list. The row stops appearing on the dashboard and in related emails; use DELETE /api/analytics/hidden_errors with the same identifying values to show it again.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

The identifying fields for the author plugin error row to hide.

kindstringrequired
The error row kind: `recipe` or `third_party`.
Allowed:recipethird_party
messagestringrequired
The row message; it is matched by shape, so numbers and urls in it may differ
ownerstringrequired
The owner of the error row: `author`, `upstream`, `installer_connection`, or `installer_setup`.
Allowed:authorupstreaminstaller_connectioninstaller_setup
subject_idintegerrequired
The recipe or third-party plugin id of the row

4 status codes
200Returns a `data` object with a `hidden` boolean indicating whether the error row is hidden.
dataobjectoptional
400Returned when any identifying field is missing.
401Returned when the request is unauthorized.
errorstringoptional
422Returned when `kind` is not `recipe` or `third_party`.

Error handling

A 400 is returned when any of kind, subject_id, owner, or message is missing, and a 401 when the request is unauthorized. A 422 is returned when kind is not recipe or third_party. owner must be one of author, upstream, installer_connection, or installer_setup.