POST/projects/{project_id}/ratings/typed

Create typed rating via API

Create a new rating of any type (helpful, star, NPS) for a project using API key authentication.

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

Parameters

project_idpathstringrequired

Unique identifier of the project (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011

Request Body

required

Typed rating creation payload

application/json

TypedRatingCreateRequest

Request body for creating a typed rating via API key authentication

contextRatingContext

Context information for a rating

ratingRatingValuerequired

Polymorphic rating value based on type

Responses

Request

POST/projects/{project_id}/ratings/typed

curl \
  -X POST \
  "https://seggwat.com/api/v1/projects/string/ratings/typed" \
  -H "Content-Type: application/json" \
  -d '{
  "context": {
    "metadata": {},
    "path": "/docs/getting-started",
    "submitted_by": "user_12345",
    "version": "1.2.3"
  },
  "rating": "any"
}'

Response

200application/json

{
  "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