Skip to main content

Dashboard

The Dashboard in the management UI provides a real-time overview of your API gateway's traffic, performance, and health.

Accessing the dashboard

Click Dashboard in the left sidebar of the management UI.

Overview metrics

The top of the dashboard shows four key metrics for the selected time period:

MetricDescription
Total RequestsTotal number of API calls handled
Success RatePercentage of requests that returned 2xx
Avg Response TimeAverage latency in milliseconds
Error CountTotal number of 4xx and 5xx responses

Charts and tables

Requests Over Time

A line chart of request volume over time. Hover over any point to see the exact count for that interval.

Interval options: Minute / Hour / Day / Month — automatically selected based on the time range, or manually adjustable.

Status Distribution

An animated bar chart showing the proportion of responses by status class:

  • 2xx — Successful responses
  • 3xx — Redirects
  • 4xx — Client errors (auth failures, rate limits, not found)
  • 5xx — Server errors (backend failures, timeouts)

A spike in 4xx typically indicates an auth misconfiguration or policy enforcement. A spike in 5xx indicates upstream service issues.

Method Distribution

Horizontal bars with percentages for each HTTP method (GET, POST, PUT, DELETE, PATCH). Useful for spotting unexpected method usage patterns.

Top Endpoints

A ranked table of your most-called proxy endpoints showing:

  • Endpoint path and collection name
  • Total request count
  • Success rate (%)

Failed Endpoints

A ranked table of endpoints with the highest error rates showing:

  • Endpoint path and collection name
  • Total error count
  • Error rate (%)

View Logs deep link — click the View Logs icon next to any failed endpoint to open Request Logs pre-filtered for that exact path and status code, with a ±12-hour time window centered on the last failure.

Client Metrics

Top clients by request volume. Shows which partners or applications are your heaviest API consumers.


Auto-refresh

The dashboard can refresh automatically in the background without a loading flash:

OptionInterval
OffManual refresh only
5sEvery 5 seconds
10sEvery 10 seconds
30sEvery 30 seconds
1 minEvery minute
5 minEvery 5 minutes
15 minEvery 15 minutes
30 minEvery 30 minutes
1 hEvery hour

Select the interval from the refresh dropdown in the dashboard toolbar.


Filtering

Filter all charts and tables simultaneously by:

FilterEffect
Time range1h, 24h, 7d, 30d
CollectionShow metrics for a specific API collection only
ClientShow metrics for a specific consumer only

Click Reset Filters to return to the full view. All active filters are applied to every chart, table, and summary metric on the page.

Prometheus integration

Zerq exposes a /metrics endpoint compatible with Prometheus. Scrape this endpoint to pull metrics into your Grafana dashboards, alerting rules, and long-term storage.

For detailed request logs and per-request debugging, see Request Logs.

  • Request Logs — filter, search, and inspect individual requests
  • Audit Logs — track who changed what in the platform