Skip to main content

Can reports be retrieved via the API?

How to find a report's ID and the URL to open it

Written by Petr Pech

Dashboards can be invoked remotely — however, this is not a data-based REST API call, but rather opening the web interface at the address of a specific dashboard.


Finding the Dashboard ID

Dashboards are stored in the dashboard-panel record, so you can retrieve their list via the API:

GET /c/{firma}/dashboard-panel.xml?detail=custom:id,kod,nazev

The response contains both the internal number and the code of each dashboard, for example DEFAULT-STATUS (Basic dashboard) or OBRATY (Customers). You can find the same information in the app under dashboard management.


Resulting Address

https://{server}:5434/c/{firma}/app/?authSessionId={token}&inDesktopApp=true#/dashboard/{ID}?lang=cs

Meaning of each part:

Part of the Address

Meaning

{firma}

Machine identifier of the company.

authSessionId

Authentication token — how to obtain it is described in the article Generating an Authentication Token.

{ID}

Internal number of the dashboard from the dashboard-panel record.

lang

Interface language, cs or en.

⚠️ The token in the address gets written into server logs. If you're only using this address to open the dashboard in a browser, this is acceptable; for data-based API calls, using the X-authSessionId header is safer.

ℹ️ This method does not return the actual dashboard data — it returns a web page. If you need the numbers, use the corresponding record or accounting outputs — see Accounting Balances and Movements.


Related

Did this answer your question?