Cohorts API Reference

Docs
API
Cohorts

Cohorts

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

Endpoints

`GET`	`/api/projects/:project_id/cohorts/`
`POST`	`/api/projects/:project_id/cohorts/`
`GET`	`/api/projects/:project_id/cohorts/:id/`
`PATCH`	`/api/projects/:project_id/cohorts/:id/`
`DELETE`	`/api/projects/:project_id/cohorts/:id/`
`GET`	`/api/projects/:project_id/cohorts/:id/persons/`

List all cohorts

Path Parameters

project_id
string

Query Parameters

limit
integer
offset
integer

Response

Request

GET /api/projects/:project_id/cohorts

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/projects/:project_id/cohorts/

Response

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": {
        "property1": null,
        "property2": null
      },
      "deleted": true,
      "filters": {
        "property1": null,
        "property2": null
      },
      "is_calculating": true,
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "email": "user@example.com"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "last_calculation": "2019-08-24T14:15:22Z",
      "errors_calculating": 0,
      "count": 0,
      "is_static": true
    }
  ]
}

Create cohorts

Path Parameters

project_id
string

Request Parameters

name
string
description
string
groups
object
deleted
boolean
filters
object
is_static
boolean

Response

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" \
    https://app.posthog.com/api/projects/:project_id/cohorts/\
	-d name="string"

Response

RESPONSE

{
  "id": 0,
  "name": "string",
  "description": "string",
  "groups": {
    "property1": null,
    "property2": null
  },
  "deleted": true,
  "filters": {
    "property1": null,
    "property2": null
  },
  "is_calculating": true,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "email": "user@example.com"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_calculation": "2019-08-24T14:15:22Z",
  "errors_calculating": 0,
  "count": 0,
  "is_static": true
}

Retrieve cohorts

Path Parameters

id
integer
project_id
string

Response

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" \
    https://app.posthog.com/api/projects/:project_id/cohorts/:id/

Response

RESPONSE

{
  "id": 0,
  "name": "string",
  "description": "string",
  "groups": {
    "property1": null,
    "property2": null
  },
  "deleted": true,
  "filters": {
    "property1": null,
    "property2": null
  },
  "is_calculating": true,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "email": "user@example.com"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_calculation": "2019-08-24T14:15:22Z",
  "errors_calculating": 0,
  "count": 0,
  "is_static": true
}

Update cohorts

Path Parameters

id
integer
project_id
string

Request Parameters

name
string
description
string
groups
object
deleted
boolean
filters
object
is_static
boolean

Response

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" \
    https://app.posthog.com/api/projects/:project_id/cohorts/:id/\
	-d name="string"

Response

RESPONSE

{
  "id": 0,
  "name": "string",
  "description": "string",
  "groups": {
    "property1": null,
    "property2": null
  },
  "deleted": true,
  "filters": {
    "property1": null,
    "property2": null
  },
  "is_calculating": true,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "email": "user@example.com"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_calculation": "2019-08-24T14:15:22Z",
  "errors_calculating": 0,
  "count": 0,
  "is_static": true
}

Delete cohorts

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

Path Parameters

id
integer
project_id
string

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" \
    https://app.posthog.com/api/projects/:project_id/cohorts/:id/

Response

No response

Retrieve cohorts persons

Path Parameters

id
integer
project_id
string

Query Parameters

format
string
One of: "csv""json"

Response

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" \
    https://app.posthog.com/api/projects/:project_id/cohorts/:id/persons/

Response

RESPONSE

{
  "id": 0,
  "name": "string",
  "description": "string",
  "groups": {
    "property1": null,
    "property2": null
  },
  "deleted": true,
  "filters": {
    "property1": null,
    "property2": null
  },
  "is_calculating": true,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "email": "user@example.com"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_calculation": "2019-08-24T14:15:22Z",
  "errors_calculating": 0,
  "count": 0,
  "is_static": true
}

Cohorts

Endpoints

List all cohorts

Path Parameters

Query Parameters

Response

Request

Response

Create cohorts

Path Parameters

Request Parameters

Response

Request

Response

Retrieve cohorts

Path Parameters

Response

Request

Response

Update cohorts

Path Parameters

Request Parameters

Response

Request

Response

Delete cohorts

Path Parameters

Request

Response

Retrieve cohorts persons

Path Parameters

Query Parameters

Response

Request

Response

Questions?

Was this page useful?