Core-7

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

Endpoints

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

Update annotations

Create, Read, Update and Delete annotations. See docs for more information on annotations.

Required API key scopes

annotation:write

Path parameters

  • id
    integer
  • project_id
    string

Request parameters

  • content
    string
  • date_marker
    string
  • creation_type
  • dashboard_item
    integer
  • dashboard_id
    integer
  • deleted
    boolean
  • scope

Response


Example request

PATCH /api/projects/:project_id/annotations/: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/annotations/:id/\
	-d content="string"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "content": "string",
  "date_marker": "2019-08-24T14:15:22Z",
  "creation_type": "USR",
  "dashboard_item": 0,
  "dashboard_id": 0,
  "dashboard_name": "string",
  "insight_short_id": "string",
  "insight_name": "string",
  "insight_derived_name": "string",
  "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",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted": true,
  "scope": "dashboard_item"
}

Delete annotations

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

Required API key scopes

annotation:write

Path parameters

  • id
    integer
  • project_id
    string

Example request

DELETE /api/projects/:project_id/annotations/: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/annotations/:id/

Example response

Status 405 No response body

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/

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
            }
          ]
        }
      },
      "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": {
          "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": []
    }
  ]
}

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
    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
        }
      ]
    }
  },
  "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": {
      "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": []
}

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/

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
        }
      ]
    }
  },
  "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": {
      "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": []
}

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
    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
        }
      ]
    }
  },
  "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": {
      "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": []
}

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/

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/

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"

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/

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/

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"

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/

Example response

Status 200 No response body

List all dashboard templates

Required API key scopes

dashboard_template:read

Path parameters

  • project_id
    string

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

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

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "template_name": "string",
      "dashboard_description": "string",
      "dashboard_filters": null,
      "tags": [
        "string"
      ],
      "tiles": null,
      "variables": null,
      "deleted": true,
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": 0,
      "image_url": "string",
      "team_id": 0,
      "scope": "team",
      "availability_contexts": [
        "string"
      ]
    }
  ]
}

Create dashboard templates

Required API key scopes

dashboard_template:write

Path parameters

  • project_id
    string

Request parameters

  • template_name
    string
  • dashboard_description
    string
  • dashboard_filters
  • tags
    array
  • tiles
  • variables
  • deleted
    boolean
  • created_by
    integer
  • image_url
    string
  • scope
  • availability_contexts
    array

Response


Example request

POST /api/projects/:project_id/dashboard_templates
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/dashboard_templates/\
	-d template_name="string"

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "template_name": "string",
  "dashboard_description": "string",
  "dashboard_filters": null,
  "tags": [
    "string"
  ],
  "tiles": null,
  "variables": null,
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "image_url": "string",
  "team_id": 0,
  "scope": "team",
  "availability_contexts": [
    "string"
  ]
}

Retrieve dashboard templates

Required API key scopes

dashboard_template:read

Path parameters

  • id
    string
  • project_id
    string

Response


Example request

GET /api/projects/:project_id/dashboard_templates/: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/dashboard_templates/:id/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "template_name": "string",
  "dashboard_description": "string",
  "dashboard_filters": null,
  "tags": [
    "string"
  ],
  "tiles": null,
  "variables": null,
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "image_url": "string",
  "team_id": 0,
  "scope": "team",
  "availability_contexts": [
    "string"
  ]
}

Update dashboard templates

Required API key scopes

dashboard_template:write

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • template_name
    string
  • dashboard_description
    string
  • dashboard_filters
  • tags
    array
  • tiles
  • variables
  • deleted
    boolean
  • created_by
    integer
  • image_url
    string
  • scope
  • availability_contexts
    array

Response


Example request

PATCH /api/projects/:project_id/dashboard_templates/: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/dashboard_templates/:id/\
	-d template_name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "template_name": "string",
  "dashboard_description": "string",
  "dashboard_filters": null,
  "tags": [
    "string"
  ],
  "tiles": null,
  "variables": null,
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "image_url": "string",
  "team_id": 0,
  "scope": "team",
  "availability_contexts": [
    "string"
  ]
}
Next page →

Community questions

Questions about this page? or post a community question.