Skip to main content
cancel
Showing results for 
Search instead for 
Did you mean: 
detienne
Contributor
Contributor

Qlik API Resources to retrieve metadatas from sheets

Hi,

We have Qlik Sense Entreprise version 14.20.5, and we used Qlik APIs to retrieve some informations about applications

Actually, we used QRS API resources (/qrs/app/full and /qrs/app/object) to get availables applications list, and also for each application, get sheets list


Now, we would like to retrieve more metadatas from sheets, especially datas sources used in the sheet :

- tables and fields metadatas
- dataconnection used (database name, schema name)


is there and Qlik API resource to do this ? and if yes, what API resource could we used ?

 

4 Replies
Øystein_Kolsrud
Employee
Employee

To get data about tables and fields you will have to go through the engine API:

https://help.qlik.com/en-US/sense-developer/November2021/Subsystems/EngineAPI/Content/Sense_EngineAP...

Listing data connections is harder though, and I don't think there is any other way than to parse the script used by the app (which you can access through the engine api). However,  I think there are a couple of tools in this domain available through the community. I have never tried any of them though, so I can't make any recommendations there.

Levi_Turner
Employee
Employee

What metadata are you looking for in tables / fields? Names / count of rows?

As for data connections, there are two approaches:

1. Parse the app's lineage endpoint (/api/v1/apps/{appId}/data/lineage)

2. Parse the script logs

For (1), I am not aware of any apps which productionalize this but it's certainly possible to use.

For (2), the Data Connection Analyzer is my go to reference.

detienne
Contributor
Contributor
Author

Hi,

Thanks for your answer.

I hoped use an http connection from external client to retrieve informations (like QRS API), or engine API use websocket.

However, I will try the engine API

detienne
Contributor
Contributor
Author

Hi,

Thanks for your answer.

We are looking for followings metadatas:

  • Tables : name, description, schema, datasource information (hostname, port, databasename ...) ...
  • Fields :  table name, name, description, type ...

I hoped use an http connection from external client to retrieve informations (like QRS API).

I will try your approaches