Skip to content
UltimateTeam.ai Docs

Bulk customer health (admin)

GET
/api/v1/ml/health/all
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/ml/health/all?sort_by=score&order=desc&limit=100' \
  --header 'X-API-Key: <X-API-Key>'

Return health scores for multiple tenants (admin).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
category
Any of:
string
min_score
Any of:
integer
<= 100
max_score
Any of:
integer
<= 100
sort_by
Sort By
string
default: score /^(score|tenant|category)$/
order
Order
string
default: desc /^(asc|desc)$/
limit
Limit
integer
default: 100 >= 1 <= 1000
tenant_ids
Any of:
string

Optional comma-separated tenant IDs to filter

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List All Health Api V1 Ml Health All Get
Array<object>
HealthListItem

Per-tenant summary entry in the bulk health listing.

object
category
required
Category
string
computed_at
Any of:
string
confidence
required
Confidence
number
model_version
required
Model Version
integer
score
required
Score
integer
tenant_id
required
Tenant Id
string
Examplegenerated
[
  {
    "category": "example",
    "computed_at": "example",
    "confidence": 1,
    "model_version": 1,
    "score": 1,
    "tenant_id": "example"
  }
]

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