Amplitude · JSON Structure

Behavioral Cohorts Api Cohort List Response Structure

CohortListResponse schema from Amplitude Behavioral Cohorts API

Type: object Properties: 1
A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

CohortListResponse is a JSON Structure definition published by Amplitude, describing 1 property. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

cohorts

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amplitude/refs/heads/main/json-structure/behavioral-cohorts-api-cohort-list-response-structure.json",
  "name": "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": "int32",
            "description": "The number of users in the cohort."
          },
          "lastComputed": {
            "type": "datetime",
            "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": "int32",
            "description": "The Amplitude project ID the cohort belongs to."
          }
        }
      }
    }
  }
}