- URL:
- https://<root>/healthCheck/reports/query
- Methods:
GET- Version Introduced:
- 11.2
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The query operation returns all current health check reports for the organization, returning name of the operation, the start and end time of the health check in UTC format, and whether the organization passed or failed the check, as well as the IDs associated with each report that are needed when using the Reports-level Export and Delete operations. The HTML view of the response provides access to the Report resource.
Request parameters
| Parameter | Details |
|---|---|
(Optional) | Filters reports by their health check result. Values: |
(Required) | The maximum number of results to be included in the response. The default value is Example |
| The response format. The default format is Values: |
Example usage
The following is a sample request for the query operation:
https://organization.example.com/<context>/admin/healthCheck/reports/query?num=1000&f=htmlJSON Response example
{
"total": 1,
"num": 100,
"start": 1,
"nextStart": -1,
"runs": [
{
"owner": "user",
"createdBy": "administrator",
"runType": "manual",
"name": "DemoReport",
"startTime": 1762265900612,
"id": "ugwt3sya0z",
"endTime": 1762265906656,
"state": "completed",
"retentionDate": -1
}
]
}