Cohorts

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

GET
POST
GET
PATCH
DELETE
GET
PATCH
GET
GET
GET
PATCH
GET
GET

List all cohorts

Also available via the PostHog MCP server:

  • cohorts-list — List all cohorts

Required API key scopes

cohort:read

Query parameters

  • basic
    boolean
  • created_by_id
    integer
  • hide_behavioral_cohorts
    boolean
  • limit
    integer
  • offset
    integer
  • search
    string
  • type
    string
    One of: "dynamic""static"

Response


Example request

GET /api/projects/:project_id/cohorts
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "groups": null,
      "deleted": true,
      "filters": {
        "properties": {
          "type": "AND",
          "values": [
            {
              "bytecode": null,
              "bytecode_error": null,
              "conditionHash": null,
              "type": "behavioral",
              "key": "string",
              "value": "string",
              "event_type": "string",
              "time_value": null,
              "time_interval": null,
              "negation": false,
              "operator": null,
              "operator_value": null,
              "seq_time_interval": null,
              "seq_time_value": null,
              "seq_event": null,
              "seq_event_type": null,
              "total_periods": null,
              "min_periods": null,
              "event_filters": null,
              "explicit_datetime": null,
              "explicit_datetime_to": null
            }
          ]
        },
        "filterTestAccounts": null
      },
      "query": null,
      "version": 0,
      "pending_version": 0,
      "is_calculating": true,
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "last_calculation": "2019-08-24T14:15:22Z",
      "last_backfill_person_properties_at": "2019-08-24T14:15:22Z",
      "errors_calculating": 0,
      "last_error_message": "string",
      "count": 0,
      "last_import_total_count": 0,
      "last_import_unmatched_count": 0,
      "is_static": true,
      "cohort_type": "static",
      "condition_type": {
        "person_properties": true,
        "behavioral": true,
        "lifecycle": true,
        "cohorts": true
      },
      "realtime": {
        "state": "static",
        "ready_at": "2019-08-24T14:15:22Z",
        "build": {
          "phase": "waiting",
          "percent_complete": 0,
          "updated_at": "2019-08-24T14:15:22Z"
        }
      },
      "experiment_set": [
        0
      ],
      "search_match_type": "exact",
      "_create_in_folder": "string",
      "_create_static_person_ids": []
    }
  ]
}

Create cohorts

Also available via the PostHog MCP server:

  • cohorts-create — Create cohort

Required API key scopes

cohort:write

Request parameters

  • name
    string | null
  • description
    string
  • groups
  • deleted
    boolean
  • filters
  • query
  • is_static
    boolean
  • cohort_type
  • _create_in_folder
    string
  • _create_static_person_ids
    array
    Default:

Response


Example request

POST /api/projects/:project_id/cohorts
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/\
	-d name="string"

Example response

Status 201
RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "groups": null,
  "deleted": true,
  "filters": {
    "properties": {
      "type": "AND",
      "values": [
        {
          "bytecode": null,
          "bytecode_error": null,
          "conditionHash": null,
          "type": "behavioral",
          "key": "string",
          "value": "string",
          "event_type": "string",
          "time_value": null,
          "time_interval": null,
          "negation": false,
          "operator": null,
          "operator_value": null,
          "seq_time_interval": null,
          "seq_time_value": null,
          "seq_event": null,
          "seq_event_type": null,
          "total_periods": null,
          "min_periods": null,
          "event_filters": null,
          "explicit_datetime": null,
          "explicit_datetime_to": null
        }
      ]
    },
    "filterTestAccounts": null
  },
  "query": null,
  "version": 0,
  "pending_version": 0,
  "is_calculating": true,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_calculation": "2019-08-24T14:15:22Z",
  "last_backfill_person_properties_at": "2019-08-24T14:15:22Z",
  "errors_calculating": 0,
  "last_error_message": "string",
  "count": 0,
  "last_import_total_count": 0,
  "last_import_unmatched_count": 0,
  "is_static": true,
  "cohort_type": "static",
  "condition_type": {
    "person_properties": true,
    "behavioral": true,
    "lifecycle": true,
    "cohorts": true
  },
  "realtime": {
    "state": "static",
    "ready_at": "2019-08-24T14:15:22Z",
    "build": {
      "phase": "waiting",
      "percent_complete": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "experiment_set": [
    0
  ],
  "search_match_type": "exact",
  "_create_in_folder": "string",
  "_create_static_person_ids": []
}

Retrieve cohorts

Also available via the PostHog MCP server:

  • cohorts-retrieve — Get cohort

Required API key scopes

cohort:read

Path parameters

  • id
    integer

Response


Example request

GET /api/projects/:project_id/cohorts/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/:id/

Example response

Status 200
RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "groups": null,
  "deleted": true,
  "filters": {
    "properties": {
      "type": "AND",
      "values": [
        {
          "bytecode": null,
          "bytecode_error": null,
          "conditionHash": null,
          "type": "behavioral",
          "key": "string",
          "value": "string",
          "event_type": "string",
          "time_value": null,
          "time_interval": null,
          "negation": false,
          "operator": null,
          "operator_value": null,
          "seq_time_interval": null,
          "seq_time_value": null,
          "seq_event": null,
          "seq_event_type": null,
          "total_periods": null,
          "min_periods": null,
          "event_filters": null,
          "explicit_datetime": null,
          "explicit_datetime_to": null
        }
      ]
    },
    "filterTestAccounts": null
  },
  "query": null,
  "version": 0,
  "pending_version": 0,
  "is_calculating": true,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_calculation": "2019-08-24T14:15:22Z",
  "last_backfill_person_properties_at": "2019-08-24T14:15:22Z",
  "errors_calculating": 0,
  "last_error_message": "string",
  "count": 0,
  "last_import_total_count": 0,
  "last_import_unmatched_count": 0,
  "is_static": true,
  "cohort_type": "static",
  "condition_type": {
    "person_properties": true,
    "behavioral": true,
    "lifecycle": true,
    "cohorts": true
  },
  "realtime": {
    "state": "static",
    "ready_at": "2019-08-24T14:15:22Z",
    "build": {
      "phase": "waiting",
      "percent_complete": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "experiment_set": [
    0
  ],
  "search_match_type": "exact",
  "_create_in_folder": "string",
  "_create_static_person_ids": []
}

Update cohorts

Also available via the PostHog MCP server:

  • cohorts-partial-update — Update cohort

Required API key scopes

cohort:write

Path parameters

  • id
    integer

Request parameters

  • name
    string | null
  • description
    string
  • groups
  • deleted
    boolean
  • filters
  • query
  • is_static
    boolean
  • cohort_type
  • _create_in_folder
    string
  • _create_static_person_ids
    array
    Default:

Response


Example request

PATCH /api/projects/:project_id/cohorts/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/:id/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "groups": null,
  "deleted": true,
  "filters": {
    "properties": {
      "type": "AND",
      "values": [
        {
          "bytecode": null,
          "bytecode_error": null,
          "conditionHash": null,
          "type": "behavioral",
          "key": "string",
          "value": "string",
          "event_type": "string",
          "time_value": null,
          "time_interval": null,
          "negation": false,
          "operator": null,
          "operator_value": null,
          "seq_time_interval": null,
          "seq_time_value": null,
          "seq_event": null,
          "seq_event_type": null,
          "total_periods": null,
          "min_periods": null,
          "event_filters": null,
          "explicit_datetime": null,
          "explicit_datetime_to": null
        }
      ]
    },
    "filterTestAccounts": null
  },
  "query": null,
  "version": 0,
  "pending_version": 0,
  "is_calculating": true,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_calculation": "2019-08-24T14:15:22Z",
  "last_backfill_person_properties_at": "2019-08-24T14:15:22Z",
  "errors_calculating": 0,
  "last_error_message": "string",
  "count": 0,
  "last_import_total_count": 0,
  "last_import_unmatched_count": 0,
  "is_static": true,
  "cohort_type": "static",
  "condition_type": {
    "person_properties": true,
    "behavioral": true,
    "lifecycle": true,
    "cohorts": true
  },
  "realtime": {
    "state": "static",
    "ready_at": "2019-08-24T14:15:22Z",
    "build": {
      "phase": "waiting",
      "percent_complete": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "experiment_set": [
    0
  ],
  "search_match_type": "exact",
  "_create_in_folder": "string",
  "_create_static_person_ids": []
}

Delete cohorts

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

cohort:write

Path parameters

  • id
    integer

Example request

DELETE /api/projects/:project_id/cohorts/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/:id/

Example response

Status 405 No response body

Retrieve cohorts activity

Required API key scopes

activity_log:read

Path parameters

  • id
    integer

Query parameters

  • limit
    integer
    Default: 10
  • page
    integer
    Default: 1

Response


Example request

GET /api/projects/:project_id/cohorts/:id/activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/:id/activity/

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "user": {},
      "activity": "string",
      "scope": "string",
      "item_id": "string",
      "detail": {
        "id": "string",
        "changes": [
          {
            "type": "string",
            "action": "string",
            "field": "string",
            "before": null,
            "after": null
          }
        ],
        "merge": {
          "type": "string",
          "source": null,
          "target": null
        },
        "trigger": {
          "job_type": "string",
          "job_id": "string",
          "payload": null
        },
        "name": "string",
        "short_id": "string",
        "type": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "is_system": true,
      "was_impersonated": true,
      "client": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "total_count": 0
}
Status 404 No response body

Update cohorts add persons to static cohort

Also available via the PostHog MCP server:

  • cohorts-add-persons-to-static-cohort-partial-update — Add persons to static cohort

Required API key scopes

cohort:write

Path parameters

  • id
    integer

Request parameters

  • person_ids
    array

Example request

PATCH /api/projects/:project_id/cohorts/:id/add_persons_to_static_cohort
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/:id/add_persons_to_static_cohort/\
	-d person_ids="array"

Example response

Status 200 No response body

Retrieve cohorts blocking workflows

Active workflows that block deleting this cohort or editing it so it stops updating in real time.

Required API key scopes

cohort:read

Path parameters

  • id
    integer

Response


Example request

GET /api/projects/:project_id/cohorts/:id/blocking_workflows
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/:id/blocking_workflows/

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "id": "string",
      "name": "string",
      "status": "string"
    }
  ],
  "total": 0,
  "hidden": 0,
  "has_more": true
}

Retrieve cohorts calculation history

Required API key scopes

cohort:read

Path parameters

  • id
    integer

Example request

GET /api/projects/:project_id/cohorts/:id/calculation_history
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/:id/calculation_history/

Example response

Status 200 No response body

Retrieve cohorts persons

Required API key scopes

cohort:readperson:read

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "csv""json"
  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/projects/:project_id/cohorts/:id/persons
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/:id/persons/

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "id": "string",
      "properties": {},
      "created_at": "2019-08-24T14:15:22Z",
      "matched_recordings": [
        {}
      ],
      "value_at_data_point": 0,
      "type": "person",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "name": "string",
      "distinct_ids": [
        "string"
      ],
      "last_seen_at": "2019-08-24T14:15:22Z",
      "is_identified": true
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Update cohorts remove person from static cohort

Required API key scopes

cohort:write

Path parameters

  • id
    integer

Request parameters

  • person_id
    string

Example request

PATCH /api/projects/:project_id/cohorts/:id/remove_person_from_static_cohort
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/:id/remove_person_from_static_cohort/\
	-d person_id="string"

Example response

Status 200 No response body

Retrieve cohorts used in

Required API key scopes

cohort:read

Path parameters

  • id
    integer

Response


Example request

GET /api/projects/:project_id/cohorts/:id/used_in
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/:id/used_in/

Example response

Status 200
RESPONSE
{
  "feature_flags": {
    "results": [
      {
        "id": 0,
        "key": "string",
        "name": "string",
        "archived": true
      }
    ],
    "total": 0,
    "hidden": 0,
    "has_more": true
  },
  "insights": {
    "results": [
      {
        "id": 0,
        "short_id": "string",
        "name": "string"
      }
    ],
    "total": 0,
    "hidden": 0,
    "has_more": true
  },
  "cohorts": {
    "results": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "total": 0,
    "hidden": 0,
    "has_more": true
  },
  "test_account_filters": {
    "results": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "total": 0,
    "has_more": true
  },
  "workflows": {
    "results": [
      {
        "id": "string",
        "name": "string",
        "status": "string"
      }
    ],
    "total": 0,
    "hidden": 0,
    "has_more": true
  }
}

Retrieve cohorts all activity

Required API key scopes

activity_log:read

Example request

GET /api/projects/:project_id/cohorts/activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/cohorts/activity/

Example response

Status 200 No response body