Skip to navigation

List evaluation criteria results for text conversations

View as Markdown

One row per evaluation criterion (as configured on the agent in the voice engine, e.g. consulta_resuelta) found on analysed text conversations created in the window, with its success / failure / unknown counts. Criteria are discovered from the data, so a newly configured criterion appears without any change on your side. Rows are sorted by criterion id.

Only analysed threads count. A verdict other than success or failure (including a missing one) is counted as unknown. successRate is a FRACTION from 0 to 1 over decided results only (success / (success + failure)) and is null when nothing was decided; it is not a 0-100 percentage like the voice endpoints. For a voice + text roll-up of the same criteria use GET /api/analytics/analysis/criteria.

No data. An empty data array when no analysed conversation in range carries criteria.

Idempotency. Read-only; safe to retry.

Consistency. Computed live on every request; Cache-Control: private, max-age=30, stale-while-revalidate=900.

Access

  • Required scope: read. Signed-in users need the owner, admin, member or viewer role.
  • Rate limit: Analytics — 30 requests/min per workspace, shared with the rest of /api/analytics/*; also counts against the general API limit. See Rate limits.
  • Plan: Available on every plan. Requires an active subscription (active, trialing or past_due); without one the request is refused with 403 BILLING_ERROR (metadata.kind: subscription_required).

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

ScopeGET / HEADPOST / PUT / PATCH / DELETEAdmin-only routes
readYesNoNo
writeYesYesNo
fullYesYesYes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Query parameters

daysintegerOptional1-365Defaults to 30

Window in days ending now. Integer 1-365; anything else is rejected with 400.

channelenumOptional

Restrict to one channel. Omit for every text channel. Any other value is a 400.

Allowed values:

Response

Criteria breakdown, one row per criterion id.
datalist of objectsOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error