Skip to content

Caller's cross-deal engagement summary

GET
/api/canvas/{deal_id}/engagement/summary
curl --request GET \
--url 'https://example.com/api/canvas/example/engagement/summary?days=30' \
--header 'Authorization: Bearer <token>'

Return a cross-deal engagement rollup for the authenticated user.

Returns None when the user has fewer than 3 finalized deals in the window (anonymity guard). Org scoping is taken from the JWT — never accepted as a query param.

deal_id
required
Deal Id
string
days
Days

Lookback window in days (1-365, default 30)

integer
default: 30 >= 1 <= 365

Lookback window in days (1-365, default 30)

Successful Response

Media type application/json
Any of:
object
key
additional properties
any
Example generated
{}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
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": {}
}
]
}