Skip to main content
GET
/
projects
/
{project_id}
/
ratings
curl -X GET "https://seggwat.com/api/v1/projects/507f1f77bcf86cd799439011/ratings?page=1&limit=10&value=true" \
  -H "X-API-Key: oat_xxxxxxxxxxxxxxxxxxxxx"

{
  "ratings": [
    {
      "id": "507f1f77bcf86cd799439011",
      "project_id": "507f1f77bcf86cd799439022",
      "value": true,
      "path": "/docs/getting-started",
      "version": "1.2.3",
      "submitted_by": "user_12345",
      "archived": false,
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": "507f1f77bcf86cd799439012",
      "project_id": "507f1f77bcf86cd799439022",
      "value": true,
      "path": "/docs/api-reference",
      "version": null,
      "submitted_by": null,
      "archived": false,
      "created_at": "2024-01-14T15:45:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 42,
    "total_pages": 5
  }
}

​
Authentication

​
X-API-Key
string
required
Your Organization Access Token. See Authentication for details.

​
Path Parameters

​
project_id
string
required
The unique identifier of the project. You can find this in the dashboard under project settings.

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination (1-indexed).
​
limit
integer
default:"20"
Number of items per page. Maximum: 100.
​
value
boolean
Filter by rating value:
  • true - Helpful ratings (thumbs up)
  • false - Not helpful ratings (thumbs down)
​
path
string
Filter by page path where the rating was submitted.

​
Response

​
ratings
array
Array of rating items.
​
pagination
object
Pagination metadata.
curl -X GET "https://seggwat.com/api/v1/projects/507f1f77bcf86cd799439011/ratings?page=1&limit=10&value=true" \
  -H "X-API-Key: oat_xxxxxxxxxxxxxxxxxxxxx"

{
  "ratings": [
    {
      "id": "507f1f77bcf86cd799439011",
      "project_id": "507f1f77bcf86cd799439022",
      "value": true,
      "path": "/docs/getting-started",
      "version": "1.2.3",
      "submitted_by": "user_12345",
      "archived": false,
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": "507f1f77bcf86cd799439012",
      "project_id": "507f1f77bcf86cd799439022",
      "value": true,
      "path": "/docs/api-reference",
      "version": null,
      "submitted_by": null,
      "archived": false,
      "created_at": "2024-01-14T15:45:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 42,
    "total_pages": 5
  }
}