---
title: "Get customer score (Beta)"
method: GET
path: "/entities/{id}/score"
tags: ["customer-scores"]
---

# Get customer score (Beta)

`GET /entities/{id}/score`

> 🚧 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).

## Path parameters

- `id` string, uuid, required

## Response `200`

The aggregated customer score for the entity.

- object
  - `data` CustomerScore, required — Aggregated customer score for a product hierarchy entity.
    - `id` string, uuid, required — UUID of the scored product hierarchy entity.
    - `type` 'customerScore', required — Resource type identifier.
    - `fields` CustomerScoreFields, required — Fields of a customer score resource.
      - `score` integer, required — The aggregated customer score. Higher values indicate greater aggregate customer importance. `0` means there is no customer importance data for the entity.
    - `links` CustomerScoreLinks, required — Links for navigating customer score resources.
      - `self` string, uri, required — URL of the customer score resource.

## Other responses

- `400` — Bad Request - Invalid input format or malformed request
- `401` — Unauthorized - Missing or invalid authentication credentials
- `403` — Forbidden - Insufficient permissions
- `404` — Not Found - The requested resource does not exist or is not accessible
- `408` — Request Timeout - The server did not receive a complete request within the allowed time
- `429` — Too Many Requests - API rate limit exceeded, reduce request frequency and retry after the indicated time
- `500` — Internal Server Error - An unexpected error occurred on the server, please retry or contact support

---

[API](https://skmtc.dev/productboard/apis/notes.md) · [All operations](https://skmtc.dev/productboard/apis/notes/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/productboard/notes/revisions/b4004749b60f/schema)