Get Data From Qlick Using API

[L_CareIntelligence]

I hope you’re doing well.

I’ve been exploring the Qlik REST API documentation (https://qlik.dev/apis/rest/) but haven’t found what I need regarding extracting data specifically from the screen shown in the attached screenshot. My objective is to build an API that can capture these on-screen details and output them in JSON format.

Could you please let me know:

• If there are any API endpoints or SDK methods that support extraction of screen or sheet-level data (beyond raw app or dataset metadata)?

• Any example code snippets—whether REST, QIX Engine API (WebSocket based), or SDK usage—that demonstrate retrieval of chart/sheet content or layout information.

• Links to additional documentation, guides, or samples that address this use case.

Thank you for your time and help! Any direction or pointers would be greatly appreciated.

[marksouzacosta]

Hi @L_CareIntelligence ,

I think the Enigma.js library will allow you to do that:
https://qlik.dev/toolkits/enigma-js/

Regards,

Mark Costa

[rwunderlich]

This repo has an example of traversing sheets and sheet objects using the SDK.: https://github.com/AptkQlik/PublicExamples

See companion SDK documentation here: https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/NetSDKAPI/Content/Sense_NetSDKAPI/Get...

Your first task is to spell "Qlik" correctly. 🙂

-Rob
http://www.easyqlik.com
http://masterssummit.com
http://qlikviewcookbook.com

[Øystein_Kolsrud · Accepted solution]

I think the solution you are looking for depends on how you are going to consume the data. If you want to export the contents of a particular visualization, then you can do so using the "reports" REST API (https://qlik.dev/apis/rest/reports/). Here are examples of using that API in C# to export a visualization to both Excel and PDF:

https://github.com/kolsrud/qlik_rest_sdk/tree/master/Qlik.Sense.RestClient/ExamplesQcs/ExportExcel
https://github.com/kolsrud/qlik_rest_sdk/tree/master/Qlik.Sense.RestClient/ExamplesQcs/ExportPdf

But if you you want to stream the data to JSON format, then you'll need to go through the Engine API which is based on JSON-RPC over websockets. This project contains examples of how to use the "hypercube" concept in the engine to extract data:

https://github.com/kolsrud/qlik-dot-net-sdk-hypercube-usage

There are libraries for interacting with the engine API available in both JavaScript and .NET, but if you want an introduction to how that API works, then this series of blog posts can be a place to start:

https://community.qlik.com/t5/Design/Dissecting-the-Engine-API-Part-5-Multiple-Hypercube-Dimensions/...

Hope that helps!