Skip to content
UltimateTeam.ai Docs

Get Kpi Snapshots

GET
/api/v1/kpi/snapshots
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/kpi/snapshots?start_date=2026-04-15&end_date=2026-04-15' \
  --header 'X-API-Key: <X-API-Key>'

Query KPI daily snapshots for the current tenant.

Returns snapshots within the date range, optionally filtered by category. Annotations are included inline when present.

Args: start_date: Start of date range (inclusive). end_date: End of date range (inclusive). category: Optional category filter. user: Authenticated user context. db: Async database session.

Returns: List of KPISnapshotResponse objects.

Raises: HTTPException: 400 if start_date > end_date.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
start_date
required
Start Date

Start date (inclusive)

string format: date

Start date (inclusive)

end_date
required
End Date

End date (inclusive)

string format: date

End date (inclusive)

category
Any of:
string

Filter by category: revenue, agent_effectiveness, business_health

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Get Kpi Snapshots Api V1 Kpi Snapshots Get
Array<object>
KPISnapshotResponse

Response model for a single KPI daily snapshot.

Used by the /api/kpi/snapshots endpoint and consumed by the briefing page and KPI trend charts.

object
annotations
required
Any of:
Array<object>
KPIAnnotation

A single AI-generated annotation on a KPI metric.

Created by the CEO agent during the morning brief think() step. Each annotation explains a notable change in a specific metric and suggests a follow-up action.

object
change_direction
required
Change Direction
string
Allowed values: up down stable
change_magnitude
required
Change Magnitude
number
metric_id
required
Metric Id
string
reasoning
required
Reasoning
string
suggested_action
required
Suggested Action
string
category
required
Category
string
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
metrics
required
Metrics
object
key
additional properties
any
snapshot_date
required
Snapshot Date
string format: date
tenant_id
required
Tenant Id
string format: uuid
Example
[
  {
    "annotations": [
      {
        "change_direction": "up"
      }
    ]
  }
]

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