SeggWat LogoSeggWat
Dashboard
POST/projects/{project_id}/ratings

Create rating via API (helpful type)

Create a new helpful rating (thumbs up/down) for a project using API key authentication. For other rating types (star, NPS), use the /ratings/typed endpoint.

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

Parameters

project_idpathstringrequired

Unique identifier of the project (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011

Request Body

required

Rating creation payload

application/json
RatingCreateRequest

Request body for creating a helpful rating via API key authentication (legacy format)

pathstring

Optional URL path where the rating relates to

Example: /docs/getting-started
submitted_bystring

Optional user identifier who submitted the rating

Example: user-abc-123
valuebooleanrequired

Rating value - true for helpful, false for not helpful

Example: true
versionstring

Optional application version to track ratings against specific releases

Example: 2.1.0

Responses

Navigation