# Status Dashboard

The **Ethos API Health Monitor Dashboard** provides a structured overview of the performance, reliability, and recent behavior of your monitored Ethos API endpoints. This section explains how to interpret each component of the dashboard for effective API monitoring and troubleshooting.

<figure><img src="/files/mcJiCM0Cuuiz6LzDrPHz" alt=""><figcaption></figcaption></figure>

## Summary Statistics&#x20;

These metrics summarize overall performance over a selected time range:

<table><thead><tr><th width="160.111083984375">Metric</th><th>Meaning</th><th>How to Use It</th></tr></thead><tbody><tr><td><strong>AVG Error Rate</strong></td><td>Percentage of API checks that failed.</td><td>A high error rate indicates systemic issues. Monitor trends over time.</td></tr><tr><td><strong>Successful Rate</strong></td><td>Percentage of successful API responses.</td><td>This should remain high for healthy integrations.</td></tr><tr><td><strong>Active Services</strong></td><td>Number of unique API endpoints being monitored.</td><td>Helps track the scope of monitoring coverage.</td></tr><tr><td><strong>Max Latency</strong></td><td>Longest recorded response time (in milliseconds).</td><td>Useful for identifying extreme outliers or slowdowns.</td></tr><tr><td><strong>Total Runs</strong></td><td>Total number of API checks conducted in the time range.</td><td>Reflects monitoring activity volume.</td></tr><tr><td><strong>Successful Runs</strong></td><td>Count of successful API checks.</td><td>Should align closely with the successful rate percentage.</td></tr><tr><td><strong>Failed Runs</strong></td><td>Count of API checks that failed (timeouts, errors, etc.).</td><td>Frequent failures may indicate API instability or misconfiguration.</td></tr></tbody></table>

{% hint style="info" %}
**Tip:** Pay close attention to spikes in max latency and an increasing error rate, especially during peak usage periods.
{% endhint %}

***

## Health History

The dashboard also displays historical API heath check statictics. The available charts show the following information:

<figure><img src="/files/68Pz2kxSX6Iat9r1nHL9" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="Latency Percentiles Chart" %}
This chart shows how long API requests took to respond over the last month. Hover over a data point in the chart to view more information about it.&#x20;

<div align="left"><figure><img src="/files/5e19YDOPObLsr78xpsTX" alt=""><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="Overall Availability Chart" %}
This chart displays the volume of successful (blue) vs. failed (red) API checks across the selected time range.

<figure><img src="/files/LA0DI5Oci2TlxabS4z8N" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Performance per Endpoint Table" %}
This section lists individual API resources being monitored. Click on an API to view additional information about it.&#x20;

<figure><img src="/files/t126iBo4GnefOQtpp1XZ" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="130.6666259765625">Column</th><th>Description</th></tr></thead><tbody><tr><td><strong>Resource</strong></td><td>The name of the API resource being monitored.</td></tr><tr><td><strong>Status</strong></td><td>Icon indicating current health of the API.</td></tr><tr><td><strong>Last Checked</strong></td><td>Timestamp of the most recent health check.</td></tr></tbody></table>

{% hint style="info" %}
**Best Practice:** Prioritize reviewing endpoints critical to institutional operations (e.g., admissions, student records) if any show failed or degraded status.
{% endhint %}
{% endtab %}
{% endtabs %}

***

## Dashboard Usage Tips

* **Correlate failures with application issues:** Use the Failed Runs and Latency charts to identify whether end-user-reported issues align with API outages.
* **Investigate outliers:** Check endpoints with high max latency or high error rates for configuration or authentication issues.
* **Review periodically:** Set a routine to review dashboard health weekly or after key academic events (e.g., enrollment periods).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://processmaker.gitbook.io/higher-ed/ethos-api-monitor/status-dashboard.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.