Bug Reports

In-app bug reporting system. Users submit reports from the UI with optional browser context and recent API request history. Reports are assigned a public ID (bug_xxxx) and tracked through a resolution lifecycle.

Statuses

open → acknowledged → investigating → resolved / wont_fix / duplicate

Public IDs

Reports use a 4-character public ID (e.g. bug_7k3m) generated from a reduced alphabet to avoid confusion characters. Collision retry ensures uniqueness.

Transparency

Aggregate stats and anonymised recent reports are published via the public transparency endpoints (see transparency.doc.ts).

→ The Bug Reports object

Endpoints

GET https://app.speybooks.com/api/v1/bug-reports/ List bug reports POST https://app.speybooks.com/api/v1/bug-reports/ Submit a bug report GET https://app.speybooks.com/api/v1/bug-reports/{id} Get bug report details

Endpoints

GET /v1/bug-reports/ POST /v1/bug-reports/ GET /v1/bug-reports/{id}

The Bug Reports Object json

{
  "id": "bug_7k3m",
  "title": "Invoice PDF missing VAT number",
  "description": "When generating a PDF for invoice ST-2026-0015, the organisation VAT number is not shown in the header despite being set in organisation settings.",
  "severity": "medium",
  "status": "investigating",
  "pageUrl": "/invoices/inv_42",
  "browserInfo": {
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
    "platform": "MacIntel",
    "language": "en-GB",
    "viewport": {
      "width": 1440,
      "height": 900
    },
    "theme": "dark"
  },
  "apiContext": [
    {
      "method": "GET",
      "path": "/v1/invoices/inv_42",
      "status_code": 200,
      "response_time_ms": 45
    },
    {
      "method": "GET",
      "path": "/v1/invoices/inv_42/pdf",
      "status_code": 200,
      "response_time_ms": 1200
    }
  ],
  "adminNotes": "Confirmed — VAT number query joins on wrong column. Fix in v5.6.1.",
  "resolvedAt": null,
  "createdAt": "2026-02-18T14:30:00.000Z",
  "updatedAt": "2026-02-19T09:15:00.000Z"
}