API reference

Feedback

Bug reports, feedback and suggestions, as the apps' Help menu sends them.

Read the Guide

GET/v1/feedback/settings

What the report dialog needs: how many images a report takes and how large each may be.

Auth: A person's token or an API key, as Authorization: Bearer.

Get an API key

Errors

403Reports are sent by people from the apps.

curl 'https://api.cactive.com.au/v1/feedback/settings' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  images: number
  imageBytes: number
  imageTypes: ("image/png" | "image/jpeg" | "image/webp")[]
}

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: A person's token or an API key, as Authorization: Bearer.

Get an API key

Errors

403Reports are sent by people from the apps.

curl -X POST 'https://api.cactive.com.au/v1/feedback' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 201

{
  reportId: string
  status: "pending" | "received"
  uploads: {
    imageId: string
    url: string
  }[]
}

POST/v1/feedback/:reportId/submit

After the uploads: checks the images and sends the report.

Auth: A person's token or an API key, as Authorization: Bearer.

Get an API key

Path parameters

reportId
A report's id: a Mirage report's (mrp_…) or a feedback report's (fbk_…).

Errors

403Reports are sent by people from the apps.

curl -X POST 'https://api.cactive.com.au/v1/feedback/{reportId}/submit' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  reportId: string
  status: "received"
}