API reference
Feedback
Bug reports, feedback and suggestions, as the apps' Help menu sends them.
The report form in every app's Help menu (see Help and feedback) sends through these routes. They're for people in the apps: organization keys and assistants acting for someone get 403. Each person can send a limited number of reports an hour and a day (429 past it), the same report twice within ten minutes gets 409, and a report with more links than the limit is kept as spam (see Limits).
A report with images is sent in three steps: POST /v1/feedback with each image's type and size returns an upload link per image; PUT each image there with its Content-Type; then POST /v1/feedback/:reportId/submit checks them (PNG, JPEG or WebP, by their bytes) and sends the report. Reports never submitted are dropped after a day.
context describes where the report came from: the app, its version, the page's path, the browser, the window, the language and time zone, and the page's recent errors, failed requests and routes. The service cleans it again: query strings, credentials and email addresses are removed, and the organization is kept only if you belong to it.
Platform administrators triage reports at /v1/platform/feedback (see Platform administration).
GET /v1/feedback/settings
What the report dialog needs: how many images a report takes and how large each may be.
Auth: user access token or platform agent key
Response 200
{
images: number
imageBytes: number
imageTypes: ("image/jpeg" | "image/png" | "image/webp")[]
}Errors
| Status | Message |
|---|---|
403 | Reports are sent by people from the apps. |
POST /v1/feedback
Sends a bug report, feedback or a suggestion. With images (types and sizes), the report waits for them: PUT each to its uploads[].url with its type, then POST /:reportId/submit.
Auth: user access token or platform agent key
Response 201
{
reportId: string
status: "pending" | "received"
uploads: {
imageId: string
url: string
}[]
}Errors
| Status | Message |
|---|---|
403 | Reports are sent by people from the apps. |
POST /v1/feedback/:reportId/submit
After the uploads: checks the images and sends the report.
Auth: user access token or platform agent key
| Path parameter | Description |
|---|---|
:reportId | A report's id: a Mirage report's (mrp_…) or a feedback report's (fbk_…). |
Response 200
{
reportId: string
status: "received"
}Errors
| Status | Message |
|---|---|
403 | Reports are sent by people from the apps. |