Preview a cohort definition
Works out who a dynamic cohort's definition holds now, without saving it: how many people, and the first of them.
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.
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
Who a dynamic cohort holds, worked out whenever it is read.
How many of the people to return, 1 to 100. Defaults to 20.
Examples
curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/cohorts/evaluate" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "definition": { "match": "all", "conditions": [ { "kind": "performed", "event": "workout_completed", "isNegated": false, "count": { "op": "gte", "value": 3 }, "withinDays": 30, "filters": [] } ] }, "limit": 1 }'{ "count": 128, "people": [ { "id": "person_h7d2k9m4x1c6v8b3n5q0w2e7", "name": "Ada Lovelace", "email": "ada@example.com", "distinctId": "user_8231" } ]}{ "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 definition that can't run. |
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 - Retrieve a cohort
GET - Update a cohort
PATCH - Delete a cohort
DELETE - List a cohort's people
GET - 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.