Behavioral Cohorts API

Use the Behavioral Cohorts API to list all your cohorts in Amplitude, export a cohort in Amplitude, or upload a cohort.

Authorization¶

This API uses basic authentication, using the API key and secret key for your project. Pass base64-encoded credentials in the request header like {{api-key}}:{{secret-key}}. api-key replaces username, and secret-key replaces the password.

Your authorization header should look something like this:

--header 'Authorization: Basic YWhhbWwsdG9uQGFwaWdlZS5jb206bClwYXNzdzByZAo'

See Find your Amplitude Project API Credentials for help locating your credentials.

Endpoints¶

Considerations¶

• For Growth and Enterprise plans, the Behavioral Cohorts Download API has a limit of 500 requests per month.
• The limit for cohort export size is 10 million users.
• There's a concurrency limit of 5 requests across cohort downloads and the Dashboard REST API.
• Cohort Download uses an asynchronous API. Getting a cohort happens in three steps:
• Request a single cohort.
• Poll the cohort status.
• Download the file.

Get all cohorts¶

Get all discoverable cohorts for an app. Use the id for each cohort returned in the response to get a single cohort.

GET /api/3/cohorts HTTP/1.1
Host: amplitude.com
Authorization: Basic {{api-key}}:{{secret-key}}

Get all cohorts response¶

The response is a JSON object with this schema:

{
    "cohorts": [
        { COHORT_OBJECT },
        ...
        { COHORT_OBJECT },
    ]
}

Each COHORT_OBJECT returned has this schema:

{
    "lastComputed": timestamp,
    "owners": string[],
    "description": string,
    "definition": { COHORT_DEFINITION },
    "published": boolean,
    "archived": boolean,
    "name": string,
    "appId": string,
    "lastMod": timestamp,
    "type": string,
    "id": string,
    "size": integer
}

Get one cohort¶

Get a discoverable cohort using its cohort_id.

This is step one in the download a cohort operation. Use the request_id returned in the response to poll export status.

GET /api/5/cohorts/request/id HTTP/1.1
Host: amplitude.com
Authorization: Basic {{api-key}}:{{secret-key}}

Get one cohort path parameters¶

Get one cohort query parameters¶

Get one cohort response¶

Requesting a single cohort returns 202 response code with the following JSON object:

{
    'request_id': <request_id>,
    'cohort_id': <cohort_id>
}

If your authorization or the cohort_id is invalid, the request returns an error.

Get request status¶

Poll the request status using the request_id retrieved for the cohort. This is the second phase in a cohort download operation.

GET /api/5/cohorts/request-status/:request_id HTTP/1.1
Host: amplitude.com
Authorization: Basic {{api-key}}:{{secret-key}}

Get request status path parameters¶

Get request status responses¶

If the job is still running, polling the request status returns a 202 code and the async_status 'JOB INPROGRESS'.

{
    'request_id': <request_id>,
    'cohort_id': <cohort_id>,
    'async_status': 'JOB INPROGRESS'
}

If the job has finished running, polling the request status returns a 200 code and the async_status 'JOB COMPLETED'.

{
    'request_id': <request_id>,
    'cohort_id': <cohort_id>,
    'async_status': 'JOB COMPLETED'
}

Download cohort¶

When the job has finished running, download the cohort.

GET /api/5/cohorts/request/requestId/file HTTP/1.1
Host: amplitude.com
Authorization: Basic {{api-key}}:{{secret-key}}

Download cohort path parameters¶

• For small cohorts, the response body contains the cohort data.
• For large cohorts, you must download the data. If the cohort is large, the response redirects with a 302 response code to a pre-signed Amazon S3 download URL. The download URL is valid for one minute, access it immediately.
• The API request link (https://amplitude.com/api/5/cohorts/request/:requestId/file) is valid for seven days. During the seven days, you can make the same request to get a new S3 download link. Each S3 link is valid for one minute.
• Most clients used to send API requests automatically download the data from the S3 link. If your API client doesn't automatically download the cohort from the S3 link, you have one minute access it manually.

Upload cohort¶

Generate a new cohort or update an existing cohort by uploading a set of User IDs or Amplitude IDs.

POST /api/3/cohorts/upload HTTP/1.1
Host: amplitude.com
Authorization: Basic {{api-key}}:{{secret-key}}
Content-Type: application/json
Content-Length: 280

{
    "name": "New Cohort",
    "app_id": 153957,
    "id_type": "BY_AMP_ID",
    "ids": [
        "10101010101010ID1", 
        "00000010101010ID2"
    ],
    "owner": "datamonster@amplitude.com",
    "published": true
}

Upload cohort body parameters¶

Upload cohort response¶

The response is a JSON object with this schema:

{
    "cohort_id": "COHORT_ID"
}

Update cohort membership¶

Add and remove IDs to incrementally update existing cohort membership.

POST /api/3/cohorts/membership HTTP/1.1
Host: amplitude.com
Content-Type: application/json
Authorization: Basic {{api-key}}:{{secret-key}}
Content-Length: 362

{
 "cohort_id":"1a2bc3d",
 "memberships": [
   {
      "ids" : ["111",”222”],
      "id_type" : "BY_ID",
      "operation" : "ADD"
    },
    {
      "ids" : ["333",”444”],
      "id_type" : "BY_ID",
      "operation" : "REMOVE"
    },
    {
      "ids" : ["asd",”qwe”],
      "id_type" : "BY_NAME",
      "operation" : "ADD"
    }
  ],
 "skip_invalid_ids":true,
}

Perform incremental update (add / remove) to existing cohort membership.

Update cohort membership request body¶

Update cohort membership request membership JSON¶

Update cohort success response fields¶

Response memberships_result JSON¶

Update cohort error response body¶

Update cohort error response JSON¶

Still have questions? Ask them in the Community.