API Reference
Feedback
Submit and retrieve feedback via the REST API.
Feedback
Submit feedback
POST /v1/feedback
x-api-key: YOUR_API_KEY
Content-Type: application/jsonRequest body
{
"message": "The export button doesn't work in Safari",
"type": "bug",
"userId": "user_123",
"userEmail": "ada@example.com",
"userName": "Ada Lovelace",
"url": "https://app.example.com/reports",
"metadata": {
"browser": "Safari 17",
"plan": "pro"
}
}| Field | Type | Required | Description |
|---|---|---|---|
message | string | Yes | The feedback text (max 5000 chars) |
type | string | No | bug, feature, question, other |
userId | string | No | Your internal user ID |
userEmail | string | No | User's email address |
userName | string | No | User's display name |
url | string | No | Page URL where feedback was submitted |
metadata | object | No | Any additional key-value data |
Response
{
"data": {
"id": "fb_abc123",
"message": "The export button doesn't work in Safari",
"type": "bug",
"status": "open",
"createdAt": "2025-03-01T12:00:00Z"
},
"error": null,
"meta": {}
}List feedback
GET /v1/projects/{projectId}/feedback
Authorization: Bearer YOUR_SERVER_TOKENQuery parameters
| Param | Type | Default | Description |
|---|---|---|---|
page | number | 1 | Page number |
limit | number | 20 | Items per page (max 100) |
status | string | — | Filter by status: open, in_progress, closed |
type | string | — | Filter by type |
search | string | — | Full-text search |
Response
{
"data": [
{
"id": "fb_abc123",
"message": "...",
"type": "bug",
"status": "open",
"sentiment": "negative",
"priority": 85,
"tags": ["safari", "export"],
"createdAt": "2025-03-01T12:00:00Z"
}
],
"error": null,
"meta": { "page": 1, "limit": 20, "total": 143 }
}