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

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

GET
/api/v1/projects/{projectId}/analytics/cohorts/{cohortId}/people

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.

cohortId*string

The cohort's id, an_cohort_....

Query parameters

cursor?string

Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.

limit?integer

How many items to return, from 1 to 100. Defaults to 50.

Range1 <= value <= 100
search?string

Only people whose name, email or distinct id contains this, ignoring case.

Lengthlength <= 255

Examples

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

StatustypecodeWhen
400invalid_requestinvalid_analytics_cohortFor 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.

PreviousDelete a cohortNextAdd people to a cohort

On this page

AuthorizationPath parametersQuery parametersExamplesResponse bodyErrorsMore in Cohorts