Skip to content

Weekly win report

GET
/api/v1/dashboard/weekly-win

Structured weekly win report for the authenticated tenant. Optionally pass ?week= to retrieve a specific week.

Authorizations

Parameters

Query Parameters

week
Any of:
integer

ISO week number to retrieve (defaults to last completed week)

Responses

200

Successful Response

Wrapper response for GET /dashboard/weekly-win.

Attributes: data: The weekly win report payload.

object
data
required

Weekly win report payload.

Attributes: week_number: ISO week number. period_start: Start of the reporting period (ISO date string). period_end: End of the reporting period (ISO date string). highlight: The top emotional highlight of the week. revenue_total: Total revenue attributed this week. new_customers: Count of new customers acquired. costs_saved: Total costs saved by AI this week. total_actions: Total agent actions performed. estimated_hours_saved: Hours of work saved by the team. value_multiple: Overall value multiple (value delivered / platform cost). closing_message: Motivational closing sentence.

object
closing_message
string
""
costs_saved
number
estimated_hours_saved
number
highlight
string
""
new_customers
integer
period_end
string
""
period_start
string
""
revenue_total
number
total_actions
integer
value_multiple
number
week_number
integer

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string