API Dashboard

Monitor request volume, success, latency, endpoint mix, and production errors with enough context to investigate quickly. The screen connects Overview and Requests so platform and engineering teams can find the “View docs” action while checking requests and success.

Use this reference when you need to design this workflow inside an existing product. The example includes practical records such as POST /runs · 38% and GET /projects · 24%, rather than an empty visual shell.

API Dashboard
Use this template in Figr

Template facts

Screen

Analytics

Primary action

View docs

Pattern

Analytics

State

Default, loading, empty, error, permission, success

Design system

Adaptable product UI theme

What this screen helps users do

Platform and engineering teams need a clear “View docs” action without losing sight of requests, success and the affected records. Keep the decision and its outcome clear before moving to the next task.

Key elements

  • Primary action: View docs is clearly available where the task happens.
  • Main view: Overview keeps the starting point obvious.
  • Connected view: Requests supplies nearby context.
  • Metric: Requests is visible with a meaningful value.
  • Another signal: Success helps people judge what to do next.
  • Representative record: POST /runs · 38% makes the example specific.
  • Second record: GET /projects · 24% shows the pattern works beyond one item.

States worth designing

  • No data for the chosen period; show what people can do instead of leaving a blank panel.
  • Loading overview without changing the layout unexpectedly.
  • Partial or delayed metrics; explain the problem and preserve work.
  • Permission denied for requests; clarify who can continue.
  • Success after choosing View docs; confirm the result and the next step.
  • Network or data refresh failure; offer a retry without losing context.

Where this screen sits in the flow

Overview → Requests → View docs → Review outcome

Patterns used

Analytics, Overview, Requests, Endpoints, accessible states, contextual actions

Why these choices work

Make time ranges, filters and metric units clear. Show the data behind each trend so readers can test what changed.

In this design, people should be able to compare POST /runs · 38% with GET /projects · 24%. Make requests clear, then use success to explain whether the next step needs attention.

Before handing this to a designer or engineer, check keyboard focus, error copy, permissions and what happens after they choose the “View docs” action. The happy path alone is not enough.

Related UI examples: Deployment Console, Logs Explorer, Feature Flags.

Start from this in Figr

Design a api dashboard screen for our existing software product. Use our real design-system tokens, components and product language. Show Overview and Requests, include believable records such as POST /runs · 38%, and make view docs easy to find. Map loading, empty, failure, permission and success states before you create editable high-fidelity screens.

Open Figr