Skip to main content
GET
/
projects
/
{project_id}
/
ratings
/
{rating_id}
curl -X GET "https://seggwat.com/api/v1/projects/507f1f77bcf86cd799439011/ratings/507f1f77bcf86cd799439022" \
  -H "X-API-Key: oat_xxxxxxxxxxxxxxxxxxxxx"

{
  "id": "507f1f77bcf86cd799439022",
  "project_id": "507f1f77bcf86cd799439011",
  "value": true,
  "path": "/docs/getting-started",
  "version": "1.2.3",
  "submitted_by": "user_12345",
  "archived": false,
  "created_at": "2024-01-15T10:30:00Z"
}

​
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 (MongoDB ObjectId). You can find this in the dashboard under project settings.
​
rating_id
string
required
The unique identifier of the rating item.

​
Response

​
id
string
Unique identifier for the rating item.
​
project_id
string
The project this rating belongs to.
​
value
boolean
The rating value:
  • true - User found the content helpful
  • false - User found the content not helpful
​
path
string
The URL path where the rating was submitted (if available).
​
version
string
Application version when rating was submitted (if tracked via the widget’s data-version attribute).
​
submitted_by
string
User identifier from the customer’s system (if provided via the widget’s JavaScript API).
​
archived
boolean
Whether the rating has been archived (soft-deleted).
​
created_at
string
ISO 8601 timestamp when the rating was created.
curl -X GET "https://seggwat.com/api/v1/projects/507f1f77bcf86cd799439011/ratings/507f1f77bcf86cd799439022" \
  -H "X-API-Key: oat_xxxxxxxxxxxxxxxxxxxxx"

{
  "id": "507f1f77bcf86cd799439022",
  "project_id": "507f1f77bcf86cd799439011",
  "value": true,
  "path": "/docs/getting-started",
  "version": "1.2.3",
  "submitted_by": "user_12345",
  "archived": false,
  "created_at": "2024-01-15T10:30:00Z"
}