Skip to content
UltimateTeam.ai Docs

Weekly win report

GET
/api/v1/dashboard/weekly-win
curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/dashboard/weekly-win \
  --header 'X-API-Key: <X-API-Key>'

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
week
Any of:
integer

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

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
WeeklyWinDashboardResponse

Wrapper response for GET /dashboard/weekly-win.

Attributes: data: The weekly win report payload.

object
data
required
WeeklyWinDashboardData

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
Closing Message
string
""
costs_saved
Costs Saved
number
0
estimated_hours_saved
Estimated Hours Saved
number
0
highlight
Highlight
string
""
new_customers
New Customers
integer
0
period_end
Period End
string
""
period_start
Period Start
string
""
revenue_total
Revenue Total
number
0
total_actions
Total Actions
integer
0
value_multiple
Value Multiple
number
0
week_number
Week Number
integer
0
Example
{
  "data": {
    "closing_message": "",
    "costs_saved": 0,
    "estimated_hours_saved": 0,
    "highlight": "",
    "new_customers": 0,
    "period_end": "",
    "period_start": "",
    "revenue_total": 0,
    "total_actions": 0,
    "value_multiple": 0,
    "week_number": 0
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}