Skip to content

Per-deal engagement rollup

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

Return engagement metrics for one deal.

Owner-only because the rollup includes per-event-type counts which can reveal internal state (e.g., how many revision retries the deal needed). The deal-scoped surface intentionally has no anonymity guard — a single deal is its own scope.

deal_id
required
Deal Id
string

Successful Response

Media type application/json
Response Get Deal Engagement Api Canvas Deal Id Engagement Get
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": {}
}
]
}