Get personalization quality

GET/v1/campaigns/{campaign_id}/personalization-quality

Scope: campaigns:read

One row per AI personalization field 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).

Headers

AuthorizationstringRequired
Bearer followed by a space and your API key, for example Bearer vk_….

Path parameters

campaign_idstring · uuidRequired
ID of the campaign.

Query parameters

daysinteger
How many days back to count, from now
≥ 1≤ 365Default 14

Response

200

campaign_idstringRequired
daysintegerRequired
sincestringRequired
Start of the window (ISO-8601)
fieldsarray of objects
Show 10 child attributesHide child attributes
- errorinteger or null
  Runs that failed
- fallbackinteger or null
  Runs that used the field's fallback text
- field_namestring or null
- genericinteger or null
  Runs whose output was judged generic
- heldinteger or null
  Runs held back rather than sent
- held_rate_pctnumber or null
  (held + generic + error) / runs: the share of sends with no usable copy; null when there were no runs
- insufficient_datainteger or null
  Runs where the model reported too little to work with
- insufficient_data_rate_pctnumber or null
  insufficient_data / runs; null when there were no runs
- runsinteger or null
  Live sends where the field was resolved
- successinteger or null
  Runs that produced personalised copy
successboolean
Default true
total_runsinteger
Default 0

Errors

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

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