Cohorts API Reference

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`

List all cohorts

Required API key scopes

cohort:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/cohorts/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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": null,
      "query": null,
      "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": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "last_calculation": "2019-08-24T14:15:22Z",
      "errors_calculating": 0,
      "last_error_message": "string",
      "count": 0,
      "is_static": true,
      "cohort_type": "static",
      "experiment_set": [
        0
      ],
      "_create_in_folder": "string",
      "_create_static_person_ids": [
        "string"
      ]
    }
  ]
}

Create cohorts

Required API key scopes

cohort:write

Path parameters

project_id
string

Request parameters

name
string
description
string
groups
deleted
boolean
filters
query
is_static
boolean
cohort_type
_create_in_folder
string
_create_static_person_ids
array

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/cohorts/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "groups": null,
  "deleted": true,
  "filters": null,
  "query": null,
  "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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_calculation": "2019-08-24T14:15:22Z",
  "errors_calculating": 0,
  "last_error_message": "string",
  "count": 0,
  "is_static": true,
  "cohort_type": "static",
  "experiment_set": [
    0
  ],
  "_create_in_folder": "string",
  "_create_static_person_ids": [
    "string"
  ]
}

Retrieve cohorts

Required API key scopes

cohort:read

Path parameters

id
integer
project_id
string

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/cohorts/{cohort_id}/".format(
        project_id=project_id,
		cohort_id="<the cohort id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "groups": null,
  "deleted": true,
  "filters": null,
  "query": null,
  "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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_calculation": "2019-08-24T14:15:22Z",
  "errors_calculating": 0,
  "last_error_message": "string",
  "count": 0,
  "is_static": true,
  "cohort_type": "static",
  "experiment_set": [
    0
  ],
  "_create_in_folder": "string",
  "_create_static_person_ids": [
    "string"
  ]
}

Update cohorts

Required API key scopes

cohort:write

Path parameters

id
integer
project_id
string

Request parameters

name
string
description
string
groups
deleted
boolean
filters
query
is_static
boolean
cohort_type
_create_in_folder
string
_create_static_person_ids
array

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/cohorts/{cohort_id}/".format(
        project_id=project_id,
		cohort_id="<the cohort id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "groups": null,
  "deleted": true,
  "filters": null,
  "query": null,
  "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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_calculation": "2019-08-24T14:15:22Z",
  "errors_calculating": 0,
  "last_error_message": "string",
  "count": 0,
  "is_static": true,
  "cohort_type": "static",
  "experiment_set": [
    0
  ],
  "_create_in_folder": "string",
  "_create_static_person_ids": [
    "string"
  ]
}

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
project_id
string

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/cohorts/{cohort_id}/".format(
        project_id=project_id,
		cohort_id="<the cohort id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 405 No response body

Retrieve cohorts activity retrieve

Required API key scopes

activity_log:read

Path parameters

id
integer
project_id
string

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/cohorts/{cohort_id}/activity/".format(
        project_id=project_id,
		cohort_id="<the cohort id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Update cohorts add persons to static cohort

Required API key scopes

cohort:write

Path parameters

id
integer
project_id
string

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/cohorts/{cohort_id}/add_persons_to_static_cohort/".format(
        project_id=project_id,
		cohort_id="<the cohort id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"person_ids": "array"
	}
).json()

Example response

Status 200 No response body

Retrieve cohorts calculation history

Required API key scopes

cohort:read

Path parameters

id
integer
project_id
string

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/cohorts/{cohort_id}/calculation_history/".format(
        project_id=project_id,
		cohort_id="<the cohort id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve cohorts duplicate as static cohort

Create a static copy of a cohort

Required API key scopes

cohort:write

Path parameters

id
integer
project_id
string

Example request

GET /api/projects/:project_id/cohorts/:id/duplicate_as_static_cohort
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/duplicate_as_static_cohort/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/cohorts/{cohort_id}/duplicate_as_static_cohort/".format(
        project_id=project_id,
		cohort_id="<the cohort id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve cohorts persons

Required API key scopes

cohort:readperson:read

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/cohorts/{cohort_id}/persons/".format(
        project_id=project_id,
		cohort_id="<the cohort id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Update cohorts remove person from static cohort

Required API key scopes

cohort:write

Path parameters

id
integer
project_id
string

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/cohorts/{cohort_id}/remove_person_from_static_cohort/".format(
        project_id=project_id,
		cohort_id="<the cohort id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"person_id": "string"
	}
).json()

Example response

Status 200 No response body

Retrieve cohorts activity

Required API key scopes

activity_log:read

Path parameters

project_id
string

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/cohorts/activity/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()