Skip to content
UltimateTeam.ai Docs

Cohort significance testing

GET
/api/v1/ml/cohorts/significance
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/ml/cohorts/significance?cohort_type=signup_week&metric=retention_rate&period_index=4' \
  --header 'X-API-Key: <X-API-Key>'

Return cohort pairs with statistically significant differences (admin/owner).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
cohort_type
Cohort Type
string
default: signup_week /^(signup_week|plan_tier|industry|company_size|acquisition_channel)$/
metric
Metric
string
default: retention_rate
period_index
Period Index
integer
default: 4 <= 36

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Get Cohort Significance Api V1 Ml Cohorts Significance Get
Array<object>
CohortSignificanceItem
object
cohort_a
required
Cohort A
string
cohort_b
required
Cohort B
string
metric_a
required
Metric A
number
metric_b
required
Metric B
number
p_value
required
P Value
number
significant
required
Significant
boolean
Examplegenerated
[
  {
    "cohort_a": "example",
    "cohort_b": "example",
    "metric_a": 1,
    "metric_b": 1,
    "p_value": 1,
    "significant": true
  }
]

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