GET/projects/{project_id}/ratings

List project ratings

Retrieve a paginated list of ratings for a specific project with optional filtering by type and path.

Base URLhttps://seggwat.com/api/v1

Parameters

project_idpathstringrequired

Unique identifier of the project (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011

pagequeryinteger

Page number (1-indexed)

limitqueryinteger

Number of items per page

typequeryRatingType

Filter by rating type

valuequeryboolean

Legacy filter: Filter by helpful rating value (true = helpful, false = not helpful). Only applies to helpful type ratings.

pathquerystring

Filter by page path where the rating was submitted

Responses

Request

GET/projects/{project_id}/ratings

curl \
  "https://seggwat.com/api/v1/projects/string/ratings?page=1&limit=20&type=helpful&value=true&path=string"

Response

200application/json

{
  "pagination": {
    "limit": 20,
    "page": 1,
    "total": 42,
    "total_pages": 3
  },
  "ratings": [
    {
      "archived": false,
      "created_at": "2024-01-15T10:30:00Z",
      "id": "507f1f77bcf86cd799439011",
      "metadata": {},
      "path": "/docs/getting-started",
      "project_id": "507f1f77bcf86cd799439022",
      "rating_type": "helpful",
      "submitted_by": "user_12345",
      "value": "any",
      "version": "1.2.3"
    }
  ]
}

Navigation