Error tracking

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

Endpoints

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

Required API key scopes

error_tracking:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/error_tracking/alerts
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/error_tracking/alerts/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/alerts/".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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "enabled": true,
      "triggers": [
        "issue_created"
      ],
      "filters": {
        "events": [
          {}
        ],
        "actions": [
          {}
        ],
        "properties": [
          {}
        ],
        "filter_test_accounts": true,
        "bytecode": null
      },
      "throttle_seconds": 0,
      "destinations": [
        {
          "channel_type": "slack",
          "integration_id": 0,
          "config": {
            "channel": "string",
            "channel_name": "string"
          },
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create error tracking alerts

Required API key scopes

error_tracking:write

Request parameters

name
string
triggers
array
filters
throttle_seconds
integer
Default: 0
destinations
array

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "enabled": true,
  "triggers": [
    "issue_created"
  ],
  "filters": {
    "events": [
      {}
    ],
    "actions": [
      {}
    ],
    "properties": [
      {}
    ],
    "filter_test_accounts": true,
    "bytecode": null
  },
  "throttle_seconds": 0,
  "destinations": [
    {
      "channel_type": "slack",
      "integration_id": 0,
      "config": {
        "channel": "string",
        "channel_name": "string"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve error tracking alerts

Required API key scopes

error_tracking:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "enabled": true,
  "triggers": [
    "issue_created"
  ],
  "filters": {
    "events": [
      {}
    ],
    "actions": [
      {}
    ],
    "properties": [
      {}
    ],
    "filter_test_accounts": true,
    "bytecode": null
  },
  "throttle_seconds": 0,
  "destinations": [
    {
      "channel_type": "slack",
      "integration_id": 0,
      "config": {
        "channel": "string",
        "channel_name": "string"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update error tracking alerts

Required API key scopes

error_tracking:write

Path parameters

id
string

Request parameters

name
string
enabled
boolean
triggers
array
filters
throttle_seconds
integer
destinations
array

Response

Example request

PATCH /api/projects/:project_id/error_tracking/alerts/: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/error_tracking/alerts/: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}/error_tracking/alerts/{error_tracking_id}/".format(
        project_id=project_id,
		error_tracking_id="<the error tracking id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "enabled": true,
  "triggers": [
    "issue_created"
  ],
  "filters": {
    "events": [
      {}
    ],
    "actions": [
      {}
    ],
    "properties": [
      {}
    ],
    "filter_test_accounts": true,
    "bytecode": null
  },
  "throttle_seconds": 0,
  "destinations": [
    {
      "channel_type": "slack",
      "integration_id": 0,
      "config": {
        "channel": "string",
        "channel_name": "string"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete error tracking alerts

Required API key scopes

error_tracking:write

Path parameters

id
string

Example request

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

Example response

Status 204 No response body

List all error tracking assignment rules

Also available via the PostHog MCP server:
error-tracking-assignment-rules-list — List error tracking assignment rules

Required API key scopes

error_tracking:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/error_tracking/assignment_rules
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/error_tracking/assignment_rules/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/assignment_rules/".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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "filters": null,
      "assignee": {
        "type": "user",
        "id": 0
      },
      "order_key": 0,
      "disabled_data": null,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create error tracking assignment rules

Also available via the PostHog MCP server:
error-tracking-assignment-rules-create — Create error tracking assignment rule

Required API key scopes

error_tracking:write

Request parameters

filters
assignee
order_key
integer
Default: 0

Response

Example request

POST /api/projects/:project_id/error_tracking/assignment_rules
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/error_tracking/assignment_rules/\
	-d filters=undefined,\
	-d assignee=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/assignment_rules/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": {
    "type": "user",
    "id": 0
  },
  "order_key": 0,
  "disabled_data": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve error tracking assignment rules

Required API key scopes

error_tracking:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": {
    "type": "user",
    "id": 0
  },
  "order_key": 0,
  "disabled_data": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

id
string

Request parameters

filters
assignee

Example request

PATCH /api/projects/:project_id/error_tracking/assignment_rules/: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/error_tracking/assignment_rules/:id/\
	-d filters=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/assignment_rules/{error_tracking_id}/".format(
        project_id=project_id,
		error_tracking_id="<the error tracking id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 204 No response body

Delete error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

id
string

Example request

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

Example response

Status 204 No response body

Update error tracking assignment rules reorder

Required API key scopes

error_tracking:write

Request parameters

filters
order_key
integer
disabled_data

Example request

PATCH /api/projects/:project_id/error_tracking/assignment_rules/reorder
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/error_tracking/assignment_rules/reorder/\
	-d filters=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/assignment_rules/reorder/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200 No response body

List all error tracking bypass rules

Required API key scopes

error_tracking:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/error_tracking/bypass_rules
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/error_tracking/bypass_rules/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/bypass_rules/".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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "filters": null,
      "order_key": 0,
      "disabled_data": null,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create error tracking bypass rules

Required API key scopes

error_tracking:write

Request parameters

filters

Response

Example request

POST /api/projects/:project_id/error_tracking/bypass_rules
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/error_tracking/bypass_rules/\
	-d filters=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/bypass_rules/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "order_key": 0,
  "disabled_data": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve error tracking bypass rules

Required API key scopes

error_tracking:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "order_key": 0,
  "disabled_data": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update error tracking bypass rules

Required API key scopes

error_tracking:write

Path parameters

id
string

Request parameters

filters

Example request

PATCH /api/projects/:project_id/error_tracking/bypass_rules/: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/error_tracking/bypass_rules/:id/\
	-d filters=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/bypass_rules/{error_tracking_id}/".format(
        project_id=project_id,
		error_tracking_id="<the error tracking id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 204 No response body

Delete error tracking bypass rules

Required API key scopes

error_tracking:write

Path parameters

id
string

Example request

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

Example response

Status 204 No response body

Update error tracking bypass rules reorder

Required API key scopes

error_tracking:write

Request parameters

filters
order_key
integer
disabled_data

Example request

PATCH /api/projects/:project_id/error_tracking/bypass_rules/reorder
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/error_tracking/bypass_rules/reorder/\
	-d filters=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/bypass_rules/reorder/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Error tracking

Endpoints

List all error tracking alerts

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Create error tracking alerts

Required API key scopes

Request parameters

Response

Example request

Example response

Status 201

Retrieve error tracking alerts

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update error tracking alerts

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete error tracking alerts

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

List all error tracking assignment rules

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Create error tracking assignment rules

Required API key scopes

Request parameters

Response

Example request

Example response

Status 201

Retrieve error tracking assignment rules

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update error tracking assignment rules

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 204 No response body

Delete error tracking assignment rules

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Update error tracking assignment rules reorder

Required API key scopes

Request parameters

Example request

Example response

Status 200 No response body

List all error tracking bypass rules

Required API key scopes

Query parameters