Report API

An API Report allows users to securely share data from a data source with third-party platforms. Instead of exposing all the data, users can apply filters to select only the specific information they want to share from a data source, and generate a focused, consolidated API Report.

To consume Report API, it is mandatory for the third-party platforms to have a bearer token for authentication. To generate the bearer token, one should have Integration Access in Quixy.

How to create API Report?

Method-I:

From the Data Source List Page

• Navigate to the data source list page where you will find the list of data sources created.

• Select the Data Source for which you want to create an API Report.

• Upon selecting the Data Source an Actions panel opens on the right.

• Click the "+" icon corresponding to the Reports option in the Actions panel to start creating an API Report.

Method-II:

From Admin Menu

• Go to Admin Menu -> Reports -> Create Report.

• The platform opens a create report pop-up.

• Select a data source from the dropdown.

• Select the report type as Api.

• Enter a name for the report and provide a suitable display name that will be visible for the end-users.

• Choose or create an Add-on if required and click Next.

You will land on the API Report configuration page, where you can view all the data from the selected data source.

Now, you need to define what data should be exposed to third-party platforms. To do this, follow these steps:

1. Use the Filters option on the left to apply conditions such as task status, date range, or other relevant criteria. This helps narrow down the data to only what you want to expose.

2. Use the Columns option on the right to show or hide entire data columns. This lets you control which fields will appear in the API response.

3. Use the Data Access option at the top to define field-level access permissions. This allows you to control who can see specific fields based on user roles or custom conditions.

4. Once you’ve applied filters, selected the required columns, and configured access rules, click Save. Your configuration will now be saved as an API Report and listed under the Reports section for the selected data source.

View API Report

To view the API report:

• Go to the Data Source List page and select the data source for which the API Report was created.

• Once selected, the Actions panel will appear on the right—click on the Reports option.

• You will land on the Reports page, where you can see all the reports created using that data source.

• From the list, locate the API Report under the Report Type column and click the View icon next to it.

• The API details for that report will now be displayed, as shown in the image below.