## CSAT summary of the tenant (tenant:crm:read)

`GET /api/crm/v1/csat/summary`

Module: CRM · operationId: `getCsatSummary` · Tag: CSAT · Auth: access token (`Authorization: Bearer <accessToken>`)

Count, average rating and distribution over the tenant's feedback matching the filters of `GET /csat` (the
list's key figures: the portal sends the list's filter); without filters over all feedback. Sort, limit and
cursor are ignored.

### Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | query | string (uuid) |  | Only this feedback (the list opened by a hit of the global search; its figures cover that one rating). |
| `addressId` | query | string (uuid) |  | Only feedback for this masterdata address. |
| `ticketId` | query | string |  | Only feedback for this ticket. (max length 64) |
| `channel` | query | CSATChannel |  | (one of `PORTAL`, `EMAIL`, `PHONE`, `IN_PERSON`) |
| `from` | query | string (date-time) |  | Only feedback created at or after this time (RFC 3339). |
| `to` | query | string (date-time) |  | Only feedback created before this time (RFC 3339). |
| `search` | query | string |  | Case-insensitive substring of comment or submitter. (max length 255) |

### Responses

- **200** Summary (`application/json`)
- **400** Invalid input (`invalid`): `field` names the first invalid field, `details.fields` every one (JSON paths for
bodies, parameter names for the query). Some refusals have their own code (`invalid_sort`,
`invalid_stages`, `invalid_custom_fields`, `convert_target_required`, `invalid_csv`, …).
 (`application/json`)
- **401** Missing, invalid or expired token (no body).
- **403** The token lacks the permission (`insufficient permissions`) or has no active tenant.
 (`application/json`)
- **500** Unexpected error; details are only logged. (`application/json`)

Fields of the 200 answer:

- `averageScore` (number (double), required): Average rating; 0 without feedback.
- `distribution` (object, required): Number of ratings per value; keys `1` to `5` are always present.
- `totalCount` (integer, required): Number of ratings matching the filters.

Example 200 answer:

```json
{
  "averageScore": 4.19,
  "distribution": {
    "1": 1,
    "2": 2,
    "3": 4,
    "4": 13,
    "5": 22
  },
  "totalCount": 42
}
```

### Example request

```bash
curl -X GET 'https://api.mbcom.cloud/api/crm/v1/csat/summary' \
  -H "Authorization: Bearer $ACCESS_TOKEN"
```
