List a cohort's people
Lists the people a cohort holds now, newest first: a static cohort's people, or whoever matches a dynamic cohort's definition.
Needs project:persons:read as well.
Guide: Cohorts
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
The cohort's id, an_cohort_....
Query parameters
Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.
How many items to return, from 1 to 100. Defaults to 50.
1 <= value <= 100Only people whose name, email or distinct id contains this, ignoring case.
length <= 255Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/cohorts/an_cohort_m2x7c1q8w4e6r0t5y2u8k3v9/people" \ -H "Authorization: Bearer vh_sk_..."{ "data": [ { "id": "person_h7d2k9m4x1c6v8b3n5q0w2e7", "name": "Ada Lovelace", "email": "ada@example.com", "distinctId": "user_8231" } ], "pageInfo": { "endCursor": null, "hasNextPage": false }}{ "error": { "type": "invalid_request", "code": "invalid_analytics_cohort", "message": "Cohorts name each other in a circle: Power users names Lapsed, which names Power users." }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}{ "error": { "type": "unavailable", "code": "string", "message": "string", "param": "string" }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | invalid_analytics_cohort | For a dynamic cohort whose definition can't run, such as one naming a cohort since deleted, or a cursor from another list. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Cohorts
- List cohorts
GET - Create a cohort
POST - Preview a cohort definition
POST - Retrieve a cohort
GET - Update a cohort
PATCH - Delete a cohort
DELETE - Add people to a cohort
PUT - Remove a person from a cohort
DELETE
Something wrong or missing on this page? Tell us by email or on Discord.