VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Cohorts
Group types
Groups
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List cohorts
Create a cohort
Preview a cohort definition
Retrieve a cohort
Update a cohort
Delete a cohort
List a cohort's people
Add people to a cohort
Remove a person from a cohort

Create a cohort

Creates a cohort: a static one with its first people, or a dynamic one with its definition.

Guide: Cohorts

POST
/api/v1/projects/{projectId}/analytics/cohorts

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

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.

name*string

The cohort's name, 1 to 255 characters.

Length1 <= length <= 255
description?|

What the cohort is for, up to 4,000 characters.

kind?|

static unless given.

definition?|

Who a dynamic cohort holds. Required for one, and only allowed there.

personIds?array<>|null
fromMetric?|

Makes a static cohort of every person behind one point of a metric, as reportMetricActors lists them, at most 10,000; a point of more people is refused. Visitors never identified can't be members, so they are left out. Not with definition or personIds.

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/cohorts" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "name": "Power users",    "description": "Finished three workouts in the last 30 days.",    "kind": "dynamic",    "definition": {      "match": "all",      "conditions": [        {          "kind": "performed",          "event": "workout_completed",          "isNegated": false,          "count": {            "op": "gte",            "value": 3          },          "withinDays": 30,          "filters": []        }      ]    }  }'
{  "id": "an_cohort_q8w4e6r0t5y2u8k3v9m2x7c1",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "name": "Power users",  "description": "Finished three workouts in the last 30 days.",  "kind": "dynamic",  "definition": {    "match": "all",    "conditions": [      {        "kind": "performed",        "event": "workout_completed",        "isNegated": false,        "count": {          "op": "gte",          "value": 3        },        "withinDays": 30,        "filters": []      }    ]  },  "memberCount": 128,  "createdAt": "2026-03-05T12:00:00.000Z",  "updatedAt": "2026-03-05T12:00:00.000Z"}
{  "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

StatustypecodeWhen
400invalid_requestinvalid_analytics_cohortFor a definition that can't run, such as one naming a cohort of another project or naming cohorts in a circle, or people who aren't current people of the project.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Cohorts

  • List cohorts GET
  • Preview a cohort definition 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.

PreviousList cohortsNextPreview a cohort definition

On this page

AuthorizationPath parametersRequest bodyExamplesResponse bodyErrorsMore in Cohorts