Feedback

Endpoint POST /api/v1/feedback

Feedback is a message from a user, optionally tied to an event id so it shows on that issue.

1Request

Public key in X-Blipit-Key or ?key=. Body: message (1 to 5,000 characters, required), name (up to 128), email (validated), event_id (32 hex, dashes allowed), url (kept without its query string).

sh
curl https://in.blipit.io/api/v1/feedback \
  -H "Content-Type: application/json" -H "X-Blipit-Key: <public key>" \
  -d '{"message":"Checkout froze after I pressed pay","name":"Ana","email":"ana@example.com","event_id":"9f1c4b6d8e2a47f0b3c5d7e9a1b2c3d4"}'

2Responses

201 {id}. 400 with the field that failed. 401 unknown key.

Good to know

  • 60 requests a minute per key.
  • If the event has not been processed yet, the link to its issue is made later.
  • The 201 answer also carries ref, the report's reference such as BR-12, and emails, true when the reporter will get email updates. An optional locale (en, ar, es, fr, de, pt, it, nl, tr, zh or ja) sets the language of those emails; without it Blipit uses context.device.language, then the workspace language.
  • 409 when the data comes from a different platform than the project's, for example {"error": "This project is for iOS. Create a separate Android project in Blipit and use its key.", "reason": "platform_mismatch", "project_platform": "ios", "sent_platform": "android"}. Events, sessions, logs, OTLP traces and metrics, bug reports, replays and web vitals all answer this way. Refused data is not stored and does not count against the quota. The Blipit SDKs log this error once and stop sending for the rest of the run. To fix it, create a project for that platform and use its key.

Stuck? Email support@blipit.io. Keys and the project id for each project are under API keys in app.blipit.io.