API Reference
Reviews API
REST API endpoints for listing review responses and accessing per-question analytics.
Last updated on
List review responses
GET /api/reviewQuery parameters:
| Parameter | Type | Description |
|---|---|---|
page | number | Page number (default: 1) |
limit | number | Results per page (default: 25, max: 100) |
search | string | Search by location name |
locationId | string | Filter by location ID |
buildingId | string | Filter by building ID |
dateFrom | string | ISO 8601 start date |
dateTo | string | ISO 8601 end date |
Response:
{
"success": true,
"data": [
{
"id": "rev_abc123",
"locationName": "Reception",
"locationPath": "Main Campus / Ground Floor / Reception",
"completedAt": "2026-06-21T10:30:00Z",
"hasComment": true,
"attachmentCount": 0,
"ticketCode": "RVW-001"
}
],
"meta": {
"total": 142,
"page": 1,
"limit": 25,
"totalPages": 6
}
}Get review response
GET /api/review/:idReturns the full review response including all answers.
Get review stats
GET /api/review/statsReturns total response count and a 30-day daily trend array.
Get review analytics
GET /api/review/analyticsReturns per-question score distributions, averages, and per-location response counts.
Query parameters:
| Parameter | Type | Description |
|---|---|---|
locationId | string | Filter by location |
buildingId | string | Filter by building |
dateFrom | string | ISO 8601 start date |
dateTo | string | ISO 8601 end date |
Export review responses
GET /api/review/exportReturns a CSV file with all review responses for the authenticated tenant.