Back to Documentation

Feedback API

API reference for managing feedback on UXFeed.

Base URL

https://api.uxfeed.com/v1

List Feedback

Get all feedback for a project:

GET /projects/{projectId}/feedback

Response:
{
  "data": [
    {
      "id": "fb_123",
      "projectId": "proj_123",
      "testerId": "user_456",
      "overallRating": 4,
      "status": "submitted",
      "createdAt": "2024-01-20T10:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 5
  }
}

Get Feedback

Get details of a specific feedback:

GET /feedback/{id}

Response:
{
  "id": "fb_123",
  "projectId": "proj_123",
  "testerId": "user_456",
  "overallRating": 4,
  "uiFeedback": {
    "design": 4,
    "colors": "The color scheme is cohesive...",
    "typography": "Typography is readable...",
    "layout": "Layout is well organized..."
  },
  "uxFeedback": {
    "navigation": 5,
    "flow": "The user flow is intuitive...",
    "usability": "Overall usability is excellent...",
    "suggestions": "Consider adding..."
  },
  "bugs": [
    {
      "id": "bug_1",
      "description": "Submit button doesn't work",
      "severity": "high",
      "screenshot": "https://..."
    }
  ],
  "status": "submitted",
  "createdAt": "2024-01-20T10:00:00Z"
}

Submit Feedback

Submit feedback for a project:

POST /projects/{projectId}/feedback
Content-Type: application/json

{
  "overallRating": 4,
  "uiFeedback": {
    "design": 4,
    "colors": "Feedback on colors...",
    "typography": "Feedback on typography...",
    "layout": "Feedback on layout..."
  },
  "uxFeedback": {
    "navigation": 5,
    "flow": "Feedback on user flow...",
    "usability": "Feedback on usability...",
    "suggestions": "Suggestions for improvement..."
  },
  "bugs": [
    {
      "description": "Bug description",
      "severity": "medium",
      "screenshot": "https://...",
      "stepsToReproduce": "1. Click... 2. Navigate..."
    }
  ],
  "generalComments": "Overall thoughts..."
}

Response:
{
  "id": "fb_123",
  "status": "submitted",
  ...
}

Update Feedback

Update your feedback (only if status is 'draft'):

PATCH /feedback/{id}
Content-Type: application/json

{
  "overallRating": 5,
  "generalComments": "Updated comments..."
}

Response:
{
  "id": "fb_123",
  "overallRating": 5,
  ...
}

Mark Feedback as Helpful

Mark feedback as helpful (developers only):

POST /feedback/{id}/helpful

Response:
{
  "success": true,
  "helpfulCount": 1
}

Reply to Feedback

Reply to feedback (developers only):

POST /feedback/{id}/reply
Content-Type: application/json

{
  "message": "Thank you for the feedback! We'll implement these changes.",
  "resolvedItems": ["bug_1", "bug_2"]
}

Response:
{
  "success": true,
  "developerResponse": {
    "message": "Thank you for the feedback!",
    "resolvedItems": ["bug_1", "bug_2"],
    "createdAt": "2024-01-21T10:00:00Z"
  }
}

Query Parameters

When listing feedback, you can use these query parameters:

  • page - Page number
  • perPage - Items per page
  • status - Filter by status (draft, submitted, approved, rejected)
  • testerId - Filter by tester
  • sort - Sort by (date, rating, helpful)