Unified Dashboard Release 2.14 API
Limited Customer Release Notes
Version 2.14
June 26, 2026
New API Support for Dashboard Configurations and Data Export
With this release, we have introduced the new API support for exporting dashboard configurations along with widget data, enabling seamless integration with downstream systems and custom analytics platforms.
This API significantly enhances automation and scalability by allowing users to programmatically retrieve dashboard structures and data analysis.
The key benefits include:
- End-to-end export capability: Fetch dashboard metadata, widget configuration, and data together
- Improved automation: Eliminate manual dashboard extraction efforts
- Better integration: Enable external tools and reporting systems to consume dashboard data directly
- Enhanced observability: Gain complete visibility into export success and skipped widgets
- Performance optimization: Controlled concurrency ensures stable and efficient data retrieval at scale
Accessing APIs using Swagger
Swagger is a widely adopted specification for programmatically describing REST APIs. The Swagger UI provides all the details about the APIs and how to invoke them. This includes the HTTP verbs (GET, POST, PUT, etc.), the URL paths, allowable parameters and types, etc.
You can directly access the Swagger UI from the following URL:
http://gateway.<QualysURL>/apidocs/ud/v1#/
For example, if your account is on US Platform 2
https://gateway.qg2.apps.qualys.com/apidocs/ud/v1#/
Input ParameterInput Parameter
|
Parameter |
Mandatory/Optional |
Data Type
|
Description |
|---|---|---|---|
| dashboardUuid | Conditional | String | Unique identifier (UUID) of the dashboard to export. Either dashboardUuid or dashboardName must be provided. If both are specified, dashboardUuid takes precedence. |
| dashboardName | Conditional | String | Name/title of the dashboard(s) to export for the current customer. Used only if dashboardUuid is not provided. Supports matching multiple dashboards. |
| widgetNames |
Optional |
Array (String) |
List of widget titles to be exported. Filtering is case-insensitive. If not provided or empty, all widgets in the selected dashboard(s) are exported. |
| tagFilter |
Optional |
Object (TagFilter) | Tag-based filter applied to widget data during export. Defines how widget data is filtered using tag criteria. |
| names | Optional | Array (String) | List of tag names used to filter widget data when applying a tag filter. |
| filterCondition | Optional | String | Defines how multiple tag filters are applied. Supported values are ANY or ALL. Defaults to ANY. |
Supported Modules and Widgets
This API currently supports the following modules:
- VMDR: All widgets except Bubble charts
- ETM: All widget types
- Policy Audit: Count, Bar, Pie, Custom widgets (Overall Compliance, Top Failing Assets, Top Failing Controls, Top Failing Policies).