Skip to content
UltimateTeam.ai Docs

Get Cohorts

GET
/api/v1/admin/activation/cohorts
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/admin/activation/cohorts?window=daily' \
  --header 'X-API-Key: <X-API-Key>'

Return 12 cohorts + per-step trailing-4-week medians.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
window
Window
string
default: weekly
Allowed values: daily weekly

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
CohortPayload
object
cohorts
required
Cohorts
Array<object>
CohortRow
object
cohort_label
required
Cohort Label
string
connector_to_first_action_pct
required
Any of:
number
first_action_to_brief_pct
required
Any of:
number
is_active_cohort
required
Is Active Cohort
boolean
scan_to_connector_pct
required
Any of:
number
signup_to_scan_pct
required
Any of:
number
signups
required
Signups
integer
generated_at
required
Generated At
string
medians
required
CohortMedians
object
connector_to_first_action_pct
required
Any of:
number
first_action_to_brief_pct
required
Any of:
number
scan_to_connector_pct
required
Any of:
number
signup_to_scan_pct
required
Any of:
number
window
required
Window
string
Allowed values: daily weekly
Example
{
  "window": "daily"
}

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