# Get personalization quality

`GET https://api.versionseven.ai/v1/campaigns/{campaign_id}/personalization-quality`

One row per [AI personalization field](https://docs.versionseven.ai/guides/ai-personalization-fields) with its runs over the window by outcome (`success`, `fallback`, `generic`, `held`, `error`). `held_rate_pct` over 30 means the field is mostly not producing usable copy; `insufficient_data_rate_pct` over 60 means the data to write it is usually missing, and the field's prompt or the lead data needs attention.

`days` sets the window (default 14).

- Required scope: `campaigns:read`

## Request

**cURL**

```bash
curl "https://api.versionseven.ai/v1/campaigns/550e8400-e29b-41d4-a716-446655440000/personalization-quality" \
  -H "Authorization: Bearer $VICTORIA_API_KEY"
```

**Node.js**

```javascript
const response = await fetch("https://api.versionseven.ai/v1/campaigns/550e8400-e29b-41d4-a716-446655440000/personalization-quality", {
  headers: {
    Authorization: `Bearer ${process.env.VICTORIA_API_KEY}`,
  },
});

const data = await response.json();
```

**Python**

```python
import os

import requests

response = requests.get(
    "https://api.versionseven.ai/v1/campaigns/550e8400-e29b-41d4-a716-446655440000/personalization-quality",
    headers={
        "Authorization": f"Bearer {os.environ['VICTORIA_API_KEY']}",
    },
)
data = response.json()
```

## Headers

- `Authorization` (string, required): `Bearer` followed by a space and your API key, for example `Bearer vk_…`.

## Path parameters

- `campaign_id` (string · uuid, required): ID of the campaign.

## Query parameters

- `days` (integer, optional, ≥ 1, ≤ 365, default `14`): How many days back to count, from now

## Response

### `200`

```json
{
  "campaign_id": "550e8400-e29b-41d4-a716-446655440000",
  "days": 1,
  "since": "string",
  "fields": [
    {
      "error": 1,
      "fallback": 1,
      "field_name": "string",
      "generic": 1,
      "held": 1,
      "held_rate_pct": 1,
      "insufficient_data": 1,
      "insufficient_data_rate_pct": 1,
      "runs": 1,
      "success": 1
    }
  ],
  "success": true,
  "total_runs": 0
}
```

- `campaign_id` (string, required)
- `days` (integer, required)
- `since` (string, required): Start of the window (ISO-8601)
- `fields` (array of objects, optional)
  - `error` (integer or null, optional): Runs that failed
  - `fallback` (integer or null, optional): Runs that used the field's fallback text
  - `field_name` (string or null, optional)
  - `generic` (integer or null, optional): Runs whose output was judged generic
  - `held` (integer or null, optional): Runs held back rather than sent
  - `held_rate_pct` (number or null, optional): (held + generic + error) / runs: the share of sends with no usable copy; null when there were no runs
  - `insufficient_data` (integer or null, optional): Runs where the model reported too little to work with
  - `insufficient_data_rate_pct` (number or null, optional): insufficient\_data / runs; null when there were no runs
  - `runs` (integer or null, optional): Live sends where the field was resolved
  - `success` (integer or null, optional): Runs that produced personalised copy
- `success` (boolean, optional, default `true`)
- `total_runs` (integer, optional, default `0`)

## Errors

Errors share one JSON body: `success`, `error`, `message`, optional `details`, and `request_id`. For example:

```json
{
  "success": false,
  "error": "UNAUTHORIZED",
  "message": "Invalid or inactive API key",
  "request_id": "734d11a1-54d4-414c-9e8d-4e1ada977db4"
}
```

| Status | Code | Meaning |
| --- | --- | --- |
| 400 | `VALIDATION_ERROR` | The request didn't match the endpoint's schema: a missing or malformed field, a bad query parameter, or a value out of range. `details.errors` lists each failing field with its `field`, `message` and `type`. |
| 401 | `UNAUTHORIZED` | The `Authorization` header is missing or malformed, or the API key is unknown or has been deactivated. |
| 401 | `API_KEY_EXPIRED` | The API key is past its expiry date. Create a new key in the Victoria AI app. |
| 403 | `INSUFFICIENT_SCOPE` | The API key doesn't have the scope this endpoint requires, such as `leads:write`. |
| 403 | `ORGANIZATION_DEACTIVATED` | The organization that owns this API key has been deactivated. |
| 404 | `CAMPAIGN_NOT_FOUND` | No campaign with this ID exists in your organization. |
| 404 | `NOT_FOUND` | No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers `NOT_FOUND`. |
| 429 | `RATE_LIMITED` | Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the `Retry-After` header. See [Rate limits](https://docs.versionseven.ai/guides/rate-limits). |
| 500 | `INTERNAL_ERROR` | Something failed on our side. The response never includes internal details; quote its `request_id` when you contact support. |
| 503 | `UPSTREAM_TIMEOUT` | A service the API depends on timed out. The request is safe to retry. |
| 503 | `AUTH_UNAVAILABLE` | The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry. |

## Response headers

| Header | Description |
| --- | --- |
| `X-Request-ID` | Correlation ID for the request, also returned as `request_id` in error bodies. Send your own `X-Request-ID`, up to 128 letters, digits, `.`, `_`, `:` or `-`, and it's used instead. |
| `RateLimit-Limit` | Requests allowed to this endpoint per minute. |
| `RateLimit-Remaining` | Requests you can still send to this endpoint right now. |
| `RateLimit-Reset` | Seconds until the endpoint's full limit is available again. |
| `Retry-After` | On a `429`: seconds to wait before retrying. |