Health API Reference

Health

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

Endpoints

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

List all health issues

Required API key scopes

health_issue:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:project_id/health_issues
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/health_issues/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/health_issues/".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",
      "kind": "string",
      "severity": "critical",
      "status": "active",
      "dismissed": true,
      "payload": null,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "resolved_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Retrieve health issues

Required API key scopes

health_issue:read

Path parameters

id
string
project_id
string

Response

Example request

GET /api/environments/:project_id/health_issues/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/health_issues/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/health_issues/{health_issue_id}/".format(
        project_id=project_id,
		health_issue_id="<the health issue id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "kind": "string",
  "severity": "critical",
  "status": "active",
  "dismissed": true,
  "payload": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "resolved_at": "2019-08-24T14:15:22Z"
}

Update health issues

Required API key scopes

health_issue:write

Path parameters

id
string
project_id
string

Request parameters

dismissed
boolean

Response

Example request

PATCH /api/environments/:project_id/health_issues/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/health_issues/:id/\
	-d kind="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/health_issues/{health_issue_id}/".format(
        project_id=project_id,
		health_issue_id="<the health issue id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"kind": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "kind": "string",
  "severity": "critical",
  "status": "active",
  "dismissed": true,
  "payload": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "resolved_at": "2019-08-24T14:15:22Z"
}

Create health issues resolve

Path parameters

id
string
project_id
string

Request parameters

dismissed
boolean

Response

Example request

POST /api/environments/:project_id/health_issues/:id/resolve
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/environments/:project_id/health_issues/:id/resolve/\
	-d kind="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/health_issues/{health_issue_id}/resolve/".format(
        project_id=project_id,
		health_issue_id="<the health issue id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"kind": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "kind": "string",
  "severity": "critical",
  "status": "active",
  "dismissed": true,
  "payload": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "resolved_at": "2019-08-24T14:15:22Z"
}

Retrieve health issues summary

Path parameters

project_id
string

Response

Example request

GET /api/environments/:project_id/health_issues/summary
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/health_issues/summary/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/health_issues/summary/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "kind": "string",
  "severity": "critical",
  "status": "active",
  "dismissed": true,
  "payload": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "resolved_at": "2019-08-24T14:15:22Z"
}

Health

Endpoints

List all health issues

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Retrieve health issues

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update health issues

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Create health issues resolve

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Retrieve health issues summary

Path parameters

Response

Example request

Example response

Status 200

Community questions