Submit a bug report

POSThttps://app.speybooks.com/api/v1/bug-reports/

Submit a bug report from the in-app reporter. Captures title, description, severity, and optionally the current page URL, browser info (viewport, theme, platform), and a snapshot of the last 5 API requests for debugging context. When includeApiContext is set, the snapshot is metadata only: method, path, status code, response time, and timestamp. Request and response bodies are never captured, so no financial data is included.

The public ID is generated with collision retry (up to 5 attempts). Returns 201 with the generated public ID and initial status.

Body parameters

titlestringrequired
Short description of the symptom (5-200 characters). Displayed on the public transparency page.
min length: 5 · max length: 200
browserInfoobjectoptional
Automatically captured browser metadata.
Show child parameters
languagestringoptional
Browser language setting.
platformstringoptional
Operating system platform.
themestringoptional
Active UI theme at time of report.
lightdark
userAgentstringoptional
Browser user agent string.
viewportobjectoptional
descriptionstringoptional
Detailed steps to reproduce, expected vs actual behaviour. Not displayed publicly.
max length: 5000
includeApiContextbooleanoptional
If true, attaches the last 5 API request log entries for debugging. No financial data is included.
pageUrlstringoptional
URL of the page where the bug was encountered.
max length: 500
severitystringoptional
Bug severity. Critical: data integrity risk. High: incorrect behaviour with workaround. Medium: unexpected UX. Low: cosmetic.
criticalhighmediumlow

Response

201Bug report submitted successfully. Returns the public ID and initial status.
Show response fields
createdAtstringdate-time
ISO 8601 creation timestamp.
idstring
Public bug report ID (e.g. bug_7k3m).
severitystring
Severity level.
statusstring
Initial status (always "open").
titlestring
Report title as submitted.