Home / Help centre / Integrations & API
Integrations & API
How do I get the Dashboard numbers through the API?
Call GET /api/dashboard with a Bearer token whose owner holds dashboard:read. The reply covers counts, the severity breakdown, remediation posture and top targets, which are the same ideas the Dashboard page shows in the app.
Steps
- Send your Bearer token with the request.
- Call
GET /api/dashboard. It needsdashboard:read. - Read the response. The reference describes it as dashboard stats: counts, severity breakdown, remediation posture and top targets.
- Compare it with the Dashboard page once, so you know which field matches which card.
- Run the call on your own timer if you want to chart the numbers over time.
Good to know
The Dashboard page shows the same four ideas. Stat cards count targets, total scans, running scans and fixed issues. A chart splits findings by severity. A list ranks the most vulnerable targets by critical and high counts. A remediation block shows open, fixed and regressed issues, false positives and the fix rate.
The response reflects what the token's owner may see, so a narrow token gives narrow numbers. If a figure looks low, check the role and group scope before you suspect the scan.
The API gives you a snapshot, not a history. To track change, save each response with a timestamp, or use the diff endpoint to see what is new, fixed or regressed between two scans of one target.
For one-off reading, the page is quicker than any script. For a monthly report to leadership, a small job that stores the response is cheap to build and easy to keep running. Read what each Dashboard card means to decide which fields to chart. Not sure how to call the API at all? Start with how to authenticate requests.
Related questions
- How do I list my targets through the API?
- How do I get the new, fixed and regressed findings for a scan through the API?
- How do I authenticate requests to the Cyberlop API?
- How do I find the endpoint I need and the permission it requires?
- What can I do with the Cyberlop API?
Cyberlop dashboard overview: what each card means and what to act on
Step-by-step, with annotated screenshots.
Updated · Back to the help centre
Wiring it into your pipeline?
Share what you are building and we will help you set up the right token, profile and job.