Skip to content
em sa em sa

Get Activity

GET
/api/canvas/{deal_id}/activity
 
curl --request GET \
  --url 'https://example.com/api/canvas/example/activity?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Get the unified activity feed for a deal.

Query params: user_id: Optional filter — only events by this user. section_key: Optional filter — only events for this section. event_types: Optional comma-separated filter — only events of these types. date_from: Optional ISO 8601 lower bound (inclusive). date_to: Optional ISO 8601 upper bound (inclusive). limit: Max entries (default 50). offset: Pagination offset (default 0).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Query Parameters

Section titled “Query Parameters ”
user_id
User Id
string
section_key
Section Key
string
event_types
Any of:
string

Comma-separated event types to include. Valid: edit, comment, approval, brush, deal_share, chat_finding, suggestion_accepted.

date_from
Any of:
string

ISO 8601 lower bound (inclusive). Events before this are excluded.

date_to
Any of:
string

ISO 8601 upper bound (inclusive). Events after this are excluded.

limit
Limit
integer
default: 50
offset
Offset
integer
0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Example generated
example

422

Section titled “422 ”

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": {}
    }
  ]
}