Skip to main content
GET
Feature Feedback
Feature feedback endpoints are used by the signed-in dashboard. They are not public API-key endpoints and do not use X-NearIQ-Key. Use them to decide when the app should ask for a lightweight feature rating, record the user’s rating or dismissal, and review aggregate feedback in admin.

Check prompt eligibility

GET /api/feedback/should-prompt Returns whether the current user should see a feedback prompt for one feature. The backend checks usage thresholds, the global cooldown, per-feature rating cooldowns, and dismissal cooldowns.

Response

When no prompt is due:

Record usage

POST /api/feedback/usage Records meaningful use of a feature for the signed-in user and active workspace. Use this for dashboard interactions that happen outside a server route.

Request body

amount defaults to 1. Valid feature keys are controlled by the app config and include dashboard surfaces such as content_studio, ai_visibility, reviews, rank_tracker, reports, and ai_chat.

Submit feedback

POST /api/feedback Stores a rating, optional text feedback, or a dismissal. A rating must be between 1 and 5 unless the prompt was dismissed.

Request body

Dismissal example:

Response

Admin summary

GET /api/admin/feedback Admin-only route that returns existing generic feedback plus feature-level aggregates.

Response shape

Weekly aggregation refreshes the summary table and labels text sentiment for admin review.