Issue Details
Want to dive deeper from the Summary page? Issue Details will give you all the information you need for remediation
The Issue Details tab can be navigated to from the Summary page by changing the tab at the top of the page.
Reading Results
The results will be shown in a table with each row being a check completed by APImetrics.
Above the table, you can choose which columns to view. All are automatically shown, except the ID column and the Category from the previous page. Each column gives various information to quickly inform you of the outcome of the checks.
- Last Seen - when the issue was last seen by APImetrics.
- Server - the server the API call is going to, the domain.
- Operation - the HTTP method being used and the endpoint for the API call.
- Check - the check that was performed, such as Schema or Authentication Token.
- Variance - the issue identified by APImetrics such as an invalid value or a missing header.
- Resolution - the current resolution status for this issue. This is automatically set to Open.
Below the Unresolved Issues table, there is the Show Previously Resolved Issues button. Selecting this will open another table of all the Resolved Issues.
This table can be hidden again by selecting the same button which now shows Hide Previously Resolved Results.
Each row can also be expanded to show more information about the issue.
Expanded Options
When any row is expanded, you can add any notes to each issue for ease of communication between different team members.
Remember to select Save once you have added your Notes to ensure they are retained.
For Security checks, such as Authentication Token checks, you will be able to change the Endpoint classification in case it has been misclassified by selecting the correct one from the dropdown.
Resolution Status
There are four different options for the Resolution Status:
- Open - a new issue will automatically be set as Open. This will keep it in the Unresolved Issues table and is intended to signal that this issue has not been looked at yet.
- Acknowledged - this will keep this issue in the Unresolved Issues table and is intended to signal that this issue has been noted and is being worked on.
- Muted - this will move this issue into the Resolved Issues table and is intended to signal that this issue has been acknowledged but is not of any concern for the time being. Note: this will still show as a failure in the overall Conformance checks.
- Resolved - this will move this issue into the Resolved Issues table and is intended to signal this issue has been acknowledged and changes have been made to make it conformant.
Updated 4 months ago