Skip to content

Overview

Development

Overview

IDEs

API Explorer

Creating a Chart from a REST Endpoint Response

You can use data given by a REST web service as the source data of your chart. To do so, follow the steps below:

  1. Open the chart modal by clicking on the charts button of an existing column.

    The charts button

  2. Set the data source type of your chart as REST.

    In the appearing dialog, you may choose which type of data to build the chart from. Choose REST.

    Setting REST as the data source of a chart

  3. Provide the details of the REST endpoint so that the report can generate the appropriate request for it. The fields you need to provide in order are:

    • The URL of the REST endpoint
    • The request method to use when sending the request
    • The headers of the request to be sent (optional)
    • The array property that will be used in the chart; leave this blank if the response body is the array you want to use already
    • The name of the additional property you want to add to your array objects (optional)
    • The value of the additional property you want to add to your array objects (optional)

      You can use the item property to reference an object in the array. For example, an extra property named label whose value is set to item.month.toUpperCase() will change the array object from:

      1
      2
      3
      4
      {
          "month": "January",
          "value": 10000
      }
      

      ... to:

      1
      2
      3
      4
      5
      {
          "month": "January",
          "value": 10000,
          "label": "JANUARY"
      }
      
    • The property that should be displayed in the y-axis, which is typically a property with numerical values.

    • The property that should be displayed in the x-axis, which is typically hold the labels of the properties in the y-axis.

    Setting REST endpoint details

    Preview your REST endpoint's response

    If a request can be successfully made, you will be able to see the response of your endpoint in the Response panel, located on the top right side of the chart modal.

  4. Customize your chart's design and save your work.

    Give your new chart a name then pick a chart type and then you're good to go. Click Generate Report to finalize your work.

    Chart settings