Annotations API Reference

Docs
API
Annotations

Annotations

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

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

Endpoints

`GET`	`/api/projects/:project_id/annotations/`
`POST`	`/api/projects/:project_id/annotations/`
`GET`	`/api/projects/:project_id/annotations/:id/`
`PATCH`	`/api/projects/:project_id/annotations/:id/`
`DELETE`	`/api/projects/:project_id/annotations/:id/`

List all annotations

Path Parameters

project_id
string

Query Parameters

limit
integer
offset
integer
search
string

Response

Request

GET /api/projects/:project_id/annotations

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/annotations/

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,
      "content": "string",
      "date_marker": "2019-08-24T14:15:22Z",
      "creation_type": "USR",
      "dashboard_item": 0,
      "insight_short_id": "string",
      "insight_name": "string",
      "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",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted": true,
      "scope": "dashboard_item"
    }
  ]
}

Create annotations

Path Parameters

project_id
string

Request Parameters

content
string
date_marker
string
dashboard_item
integer
deleted
boolean
scope
string
One of: "dashboard_item""project""organization"

Response

Request

POST /api/projects/:project_id/annotations

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/annotations/\
	-d content="string"

Response

RESPONSE

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

Retrieve annotations

Path Parameters

id
integer
project_id
string

Response

Request

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

Response

RESPONSE

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

Update annotations

Path Parameters

id
integer
project_id
string

Request Parameters

content
string
date_marker
string
dashboard_item
integer
deleted
boolean
scope
string
One of: "dashboard_item""project""organization"

Response

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

Response

RESPONSE

{
  "id": 0,
  "content": "string",
  "date_marker": "2019-08-24T14:15:22Z",
  "creation_type": "USR",
  "dashboard_item": 0,
  "insight_short_id": "string",
  "insight_name": "string",
  "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",
  "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

Path Parameters

id
integer
project_id
string

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

Response

No response

Annotations

Endpoints

List all annotations

Path Parameters

Query Parameters

Response

Request

Response

Create annotations

Path Parameters

Request Parameters

Response

Request

Response

Retrieve annotations

Path Parameters

Response

Request

Response

Update annotations

Path Parameters

Request Parameters

Response

Request

Response

Delete annotations

Path Parameters

Request

Response

Questions?

Was this page useful?