cohorts

put/api/projects/{project_id}/cohorts/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/cohorts/{id}/
  • Auth: HTTP bearer

Path parameters

idinteger required

A unique integer value identifying this cohort.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

idinteger required
namestring nullable
descriptionstring
groupsunknown
deletedboolean
queryunknown
versioninteger nullable required
pending_versioninteger nullable required
is_calculatingboolean required
created_atstring date-time nullable required
last_calculationstring date-time nullable required
last_backfill_person_properties_atstring date-time nullable required
errors_calculatinginteger required
last_error_messagestring nullable required
countinteger nullable required
last_import_total_countinteger nullable required

Number of IDs supplied by the most recent static cohort import. Null if the cohort was never populated from a list of IDs.

last_import_unmatched_countinteger nullable required

How many of the IDs in the most recent static cohort import matched no person, and so were not added to the cohort.

is_staticboolean
experiment_setinteger[] required
_create_in_folderstring
_create_static_person_idsstring[]

Response

idinteger required
namestring nullable
descriptionstring
groupsunknown
deletedboolean
queryunknown
versioninteger nullable required
pending_versioninteger nullable required
is_calculatingboolean required
created_atstring date-time nullable required
last_calculationstring date-time nullable required
last_backfill_person_properties_atstring date-time nullable required
errors_calculatinginteger required
last_error_messagestring nullable required
countinteger nullable required
last_import_total_countinteger nullable required

Number of IDs supplied by the most recent static cohort import. Null if the cohort was never populated from a list of IDs.

last_import_unmatched_countinteger nullable required

How many of the IDs in the most recent static cohort import matched no person, and so were not added to the cohort.

is_staticboolean
experiment_setinteger[] required
_create_in_folderstring
_create_static_person_idsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.