32 lines
961 B
Markdown
32 lines
961 B
Markdown
# Reports Directory
|
|
|
|
This directory contains API status check reports generated by the API status checker tool.
|
|
|
|
## Files
|
|
|
|
- **JSON Reports**: Generated when running the extended API status checker
|
|
- **example-report.json**: Sample report showing the expected format
|
|
- **report-viewer.html**: HTML tool for visualizing the JSON reports
|
|
|
|
## Using the Report Viewer
|
|
|
|
To view a report:
|
|
|
|
1. Open the `report-viewer.html` file in a web browser
|
|
2. Click "Choose Report File" to select a JSON report
|
|
3. Review the report details including endpoint statuses
|
|
|
|
## Report Format
|
|
|
|
Each report includes:
|
|
|
|
- Summary statistics (success rate, endpoint counts)
|
|
- Detailed endpoint results
|
|
- Response times
|
|
- Error details
|
|
- API response data (when in verbose mode)
|
|
|
|
## Retention Policy
|
|
|
|
By default, all JSON reports in this directory are ignored by git. If you want to keep certain reports, consider copying them elsewhere or modifying the `.gitignore` file in this directory.
|