Skip to main content
GET
Widget identity is verified when signing is configured; tokenless compatibility does not establish tenant ownership. See the authentication and recovery guide for credential and retry rules.

Query parameters

string
Ignored by the analytics routes (telemetry, response review, thread analytics): their org comes only from the verified widget token, and they answer 401 unauthorized without one (outside production, STATESET_ORG_ID is a logged fallback). Kept for older clients.
string
Agent id hint (also agent_id, or header x-agent-id). Overridden by the widget token when present; must match it.
integer
Records to analyze; default 100, max 500.
string
true keeps the analyzed records in analysis.records.

Response

ResponseReviewReport
boolean
required
Fixed value: true.
string (date-time)
required
string,null
required
string,null
required
integer
required
object
required
Output of analyzeResponseRecords (src/server/responseReview.js): includes suggestions (with ruleDraft entries), workingExamples, regressionCases and, with includeRecords=true, records. Exact shape is not fixed here.
string[]
required

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on November 13, 2026