Amplitude · Schema
CohortListResponse
CohortListResponse schema from Amplitude Behavioral Cohorts API
A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior
Properties
| Name | Type | Description |
|---|---|---|
| cohorts | array | Array of cohort metadata objects. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amplitude/refs/heads/main/json-schema/behavioral-cohorts-api-cohort-list-response-schema.json",
"title": "CohortListResponse",
"description": "CohortListResponse schema from Amplitude Behavioral Cohorts API",
"type": "object",
"properties": {
"cohorts": {
"type": "array",
"description": "Array of cohort metadata objects.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the cohort."
},
"name": {
"type": "string",
"description": "The name of the cohort."
},
"description": {
"type": "string",
"description": "A description of the cohort."
},
"size": {
"type": "integer",
"description": "The number of users in the cohort."
},
"lastComputed": {
"type": "string",
"format": "date-time",
"description": "The date and time the cohort was last computed."
},
"archived": {
"type": "boolean",
"description": "Whether the cohort is archived."
},
"owner": {
"type": "string",
"description": "The email of the cohort owner."
},
"appId": {
"type": "integer",
"description": "The Amplitude project ID the cohort belongs to."
}
}
}
}
}
}