Cohorts API Reference

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/activity/`
`PATCH`	`/api/projects/:project_id/cohorts/:id/add_persons_to_static_cohort/`
`GET`	`/api/projects/:project_id/cohorts/:id/duplicate_as_static_cohort/`
`GET`	`/api/projects/:project_id/cohorts/:id/persons/`
`GET`	`/api/projects/:project_id/cohorts/activity/`

List all cohorts

Required API key scopes

cohort:read

Path parameters

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

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

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,
      "count": 0,
      "is_static": true,
      "cohort_type": "static",
      "experiment_set": [
        0
      ],
      "_create_in_folder": "string"
    }
  ]
}

Create cohorts

Required API key scopes

cohort:write

Path parameters

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

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,
  "count": 0,
  "is_static": true,
  "cohort_type": "static",
  "experiment_set": [
    0
  ],
  "_create_in_folder": "string"
}

Retrieve cohorts

Required API key scopes

cohort:read

Path parameters

id
integer
A unique integer value identifying this cohort.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

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,
  "count": 0,
  "is_static": true,
  "cohort_type": "static",
  "experiment_set": [
    0
  ],
  "_create_in_folder": "string"
}

Update cohorts

Required API key scopes

cohort:write

Path parameters

id
integer
A unique integer value identifying this cohort.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

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,
  "count": 0,
  "is_static": true,
  "cohort_type": "static",
  "experiment_set": [
    0
  ],
  "_create_in_folder": "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
A unique integer value identifying this cohort.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 405 No response body

Retrieve cohorts activity retrieve

Required API key scopes

activity_log:read

Path parameters

id
integer
A unique integer value identifying this cohort.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Update cohorts add persons to static cohort

Path parameters

id
integer
A unique integer value identifying this cohort.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Retrieve cohorts duplicate as static cohort

Path parameters

id
integer
A unique integer value identifying this cohort.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Retrieve cohorts persons

Required API key scopes

cohort:readperson:read

Path parameters

id
integer
A unique integer value identifying this cohort.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

format
string
One of: "csv""json"

Response

Status 200 No response body

Retrieve cohorts activity

Required API key scopes

activity_log:read

Path parameters

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

Cohorts

Endpoints

List all cohorts

Required API key scopes

Path parameters

Query parameters

Response

Status 200

Create cohorts

Required API key scopes

Path parameters

Response

Status 201

Retrieve cohorts

Required API key scopes

Path parameters

Response

Status 200

Update cohorts

Required API key scopes

Path parameters

Response

Status 200

Delete cohorts

Required API key scopes

Path parameters

Response

Status 405 No response body

Retrieve cohorts activity retrieve

Required API key scopes

Path parameters

Response

Status 200 No response body

Update cohorts add persons to static cohort

Path parameters

Response

Status 200 No response body

Retrieve cohorts duplicate as static cohort

Path parameters

Response

Status 200 No response body

Retrieve cohorts persons

Required API key scopes

Path parameters

Query parameters

Response

Status 200 No response body

Retrieve cohorts activity

Required API key scopes

Path parameters

Response

Status 200 No response body

Community questions