Skip to main content
Version: V3.8

QSDA API

API documentation​

Choose Help > API documentation, or open http://localhost:5003/api-docs, to browse the REST API exposed by your installed QSDA version.

Use the UI address, with its configured scheme, host, port, and optional base path. For example, a proxy deployment can use https://qsda.example.com/qsda/api-docs. The internal API port, default 5000, is loopback-only; customer scripts should use the UI port, default 5003, which proxies API requests to the service.

Authentication​

With Use API Auth enabled (the default), send an API key as a bearer token in the Authorization header. Create keys in Admin > API Keys, choose an appropriate expiry, and keep them out of shared scripts and logs.

GET /api/v1/collectors HTTP/1.1
Host: localhost:5003
Authorization: Bearer <your-api-key>

For a base-path deployment, prefix the request path too, for example /qsda/api/v1/collectors. Browser UI authorization and API-key authentication are separate.

Collection lifecycle and exports​

View and export endpoints require a collection to be loaded and analyzed. If necessary, load it first and wait for completion. The CLI provides --load on view and export-views commands to perform that sequence.

Custom API clients requesting an idleUnloadSeconds timeout on load should send the X-Qsda-Headless header on subsequent view, HTML, and export requests. Without it, those requests count as interactive use and clear the short timeout, returning the collection to the site-wide idle policy. The CLI sends this header automatically.

The analysis export endpoint accepts a format (csv, xlsx, or sqlite) and an optional schema (V37, V38.Migrate, V38, or Latest). A supplied schema overrides the project setting. See Export Analysis for compatibility and the separate Export to Qlik workflow.

Public APIs and changes​

The API reference normally shows public endpoints. Internal endpoints are implementation details and can change independently of supported automation workflows.

The API documentation links to API Changes (/apidiff, under any configured base path), where available captured versions can be compared. Developer features can expose internal APIs in the reference and comparison: right-click the QSDA logo, open Developer Settings, and enable Developer features. That preference applies to the current browser only. Use public endpoints for integrations.