How to Connect to a GraphQL Data Source in Bold Reports

GraphQL is an open-source query language that enables clients to request specific data from an API. GraphQL provides a clear and comprehensive description of the data in an API, allowing clients to request exactly what they need and nothing more. It also makes it easier to evolve APIs over time and enables powerful developer tools. GraphQL is often used as an alternative to REST APIs for fetching and manipulating data.

Currently, we don’t have direct support for GraphQL, but we can connect to it through the Web API data connector. To connect to a GraphQL API using Bold Reports through the Web API data connector, follow these steps:

1. Click on the Data icon in the configuration panel of Bold Reports.

2. In the DATA configuration panel, click on the NEW DATA button.

3. In the connection type panel, choose Web API in the DATA SOURCES pane as shown in the following snap.
   

4. Enter a valid GraphQL root URL in the URL text box. This is the endpoint URL of your GraphQL API.

5. Choose the POST Method Type from the combo box for the provided REST API. This indicates that you will be making a POST request to the GraphQL API.

6. Select the “Raw” option for the POST request. This allows you to enter the GraphQL query directly.

7. Enter your GraphQL query in the input text box below the Raw option. This is where you define the specific data you want to retrieve from the GraphQL API. You can refer to the following image.
   

   

8. Enter the remaining options, such as headers and authentication type, if required.

9. Choose a JSON data format from the combo box based on the expected response format of your GraphQL API.

10. Click on the “Connect” button to establish the connection between Bold Reports and your GraphQL API.

11. Once connected, you can drag and drop the table from the table schema onto the query design view page.

12. Preview the data in the query designer page to see the results of your GraphQL query.