customer-scores
Get customer score (Beta)
🚧 Beta
This endpoint is in beta. Its behavior may change, or it may be removed, in a future release without notice. We recommend against relying on it in production integrations.
Retrieves the aggregated customer score for a single product hierarchy entity, identified by its UUID. Use this endpoint to see, as a single number, how important an entity is to your customers based on the feedback attached to it and everything below it in the hierarchy.
The id must be the UUID of a product hierarchy entity - a product, component, feature, or subfeature.
Key Features
- Aggregates customer importance ratings on the entity and all of its descendants in the product hierarchy.
- Ratings are weighted by importance level, and anonymous feedback also
contributes:
- critical × 3
- important × 2
- nice to have × 1
- unknown × 1
- each anonymous note × 1
- not important ratings do not contribute to the score.
Important Notes
- Returns a score of 0 when the entity has no customer importance data.
- Returns 404 when id does not match a product hierarchy entity in your workspace (for example, a company, note, or user ID).
get/entities/{id}/score
Path parameters
idstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000
UUID of the product hierarchy entity to score - a product, component, feature, or subfeature.
Response
The aggregated customer score for the entity.
Example response
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "customerScore",
"fields": {
"score": 27
},
"links": {
"self": "https://api.productboard.com/v2/entities/123e4567-e89b-12d3-a456-426614174000/score"
}
}
}