Skip to content
UltimateTeam.ai Docs

Post Observation

POST
/api/v1/collective/observations
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/collective/observations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "attestation": "observed_from_authorized_source", "inputs": { "additionalProperty": 1 }, "metric_name": "example", "metric_variant": "example", "period": "example", "request_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "source_reference": "example", "window_end": "2026-04-15", "window_start": "2026-04-15" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ObservationRequest
object
attestation
required
Attestation
string
Allowed value: observed_from_authorized_source
inputs
required
Inputs
object
key
additional properties
number
metric_name
required
Metric Name
string
metric_variant
required
Metric Variant
string
period
required
Period
string
request_id
required
Request Id
string format: uuid
source_reference
required
Source Reference
string
>= 1 characters <= 2000 characters
window_end
required
Window End
string format: date
window_start
required
Window Start
string format: date

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
ObservationResult
object
dispatch_pending
required
Dispatch Pending
boolean
observation
required
ObservationResponse
object
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
metric_name
required
Metric Name
string
metric_value
required
Metric Value
number
metric_variant
required
Metric Variant
string
period
required
Period
string
policy_version
required
Policy Version
string
request_id
required
Request Id
string format: uuid
source_kind
required
Source Kind
string
Allowed values: owner_attested native_receipt
unit
required
Unit
string
window_end
required
Window End
string format: date
window_start
required
Window Start
string format: date
Example
{
  "observation": {
    "source_kind": "owner_attested"
  }
}

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