Reporting Explorer

A Reporting Explorer for REST API allows users to engage, examine, and analyze reports. It usually has functions like exporting, filtering, sorting, and data visualization, which makes it simpler for users to conclude the data without having to write code or communicate with the API directly.

User Persona: Super Admin

Configure Reporting Explorer

1. Clickicon from the top panel.

2. Navigate to Platform Studio > API Hub > Reporting Explorer.

Figure: Reporting Explorer. 

For more information, refer to the table below. 

Field	Description
Authentication	The authentication will be on the following types. Logged in User - Based on the login credentials used. Generated Token - Based on the credentials used in Authentication.
General	Select the General characteristics of the Explorer.
Domain	Select the appropriate Domain as per requirement.
Sub Domain	Select the appropriate Sub Domain as per requirement.
Application	Select the Application from which the records need to be retrieved.
Module	Select the appropriate Module as per the Application selected. For example: Incident, Service Request
Tenant	Select the appropriate Tenant from which the records are to be retrieved.
View Name	Select the View Name for the API.
Reporting Explorer
URL	The URL will auto-populate based on the table selected in Form Name. Note The URL to GET records will be based on the form name selected and will be auto populated.
Query Parameters
Default Filter	The Tenant selected in General details will be populated in this field. It can be altered based on requirement.
Add Filters	An additional filters can be applied here. Click Add Filter and the following screen is displayed. Here we can set the conditions based on which the Filters will apply. Expose Display Name - We can search using values or key Note Only two attributes can be grouped as part of the AND/OR functionality.
Limit	The number of items displayed on the list. The minimum is set as 10 by default and the maximum is 1000.
Page Number	We can limit the page numbers or set it as per requirement.
Response Fields	We can select the response fields based on the filter option. Click the Edit icon and the following page is displayed. Select the column to move the available fields to the selected fields. Use  to move the columns individually forward and backward or to move the columns together.
Time Zone	Select the preferred Time Zone. The default setting is the UTC format.
Request Headers
Request Format	Specify the format for the REST request body.
Response Format	Specify the format for the REST response body.
Authorization	Specifies the authorization and send the request as the current user.

Click Send to update the API