You can view the technical details of the OData Reporting API. This allows you to check, for example, which data external systems can retrieve via the interface.
Required Permissions
- View reports and View users
To open the interface, you need the name of an API user and their API token, which you have previously created for an external system.
Proceed as follows:
- Open the page Reports.
- Click on the gear icon to display further actions. A dropdown menu will appear.
- Click on the option Use Reporting API. The corresponding window will appear in the foreground.
- Click on the URL of the OData source. A protected page will be displayed.
- On desktop browsers, an authorization modal window usually opens immediately.
- On mobile browsers, an error page (401) may appear without the authorization modal window opening. Refresh the error page. This should display the authorization modal window.
- Enter the API user's name and API token as the username and password, then click Login. A page will be displayed, showing an XML file with some metadata. The first entry of the XML file includes the value metadata:context=URL.
- Copy the displayed URL and open it. The interface's XML file will be displayed with all the values that can be transferred via the interface.