Authorization
string
required
Example:
Authorization | Bearer Paste-Your-Api-Key-HerePath Parameters
string<uuid>
required
ID of the payment link / product whose rating statistics you want to retrieve.
Statistics count only
ACTIVE reviews. When the product has no active reviews, data is
returned as an empty object ({}).Response
Successful ResponseMain Structure (Root)
integer
Status code returned by the API.
string
Status message that describes the API response.
object
Aggregated rating statistics for the product. Empty object when there are no active reviews.
data Structure (Object)
number
Total number of active reviews for the product.
number
Average rating across all active reviews, rounded to one decimal place.
array of object
Per-rating breakdown, one entry for each rating from 5 down to 1.
number
Rating value (1–5) this breakdown entry refers to.
number
Percentage of total reviews that gave this rating.
number
Number of reviews that gave this rating.
