Get Retrieval Quality
GET
/api/canvas/{deal_id}/retrieval-quality
const url = 'https://example.com/api/canvas/example/retrieval-quality';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/canvas/example/retrieval-quality \ --header 'Authorization: Bearer <token>'Get retrieval quality summary for a deal.
Returns per-section retrieval grades, source diversity metrics, and overall deal quality assessment. Data comes from stored pipeline telemetry — no LLM calls.
Returns empty scores if no retrieval data is available (e.g., new deal without completed pipeline run).
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” deal_id
required
Deal Id
string
Responses
Section titled “ Responses ”Successful Response
Media type application/json
Example generated
exampleValidation Error
Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example", "input": "example", "ctx": {} } ]}