This allows you to query data from third-party APIs and present that data on a dashboard. If you haven't already added a provider we recommend that you use the new Web API data source instead, see Web API plugin

1. Browse to Settings > Web API > Providers and click Add new provider.

2. Enter a name for the provider, for example Star Wars

3. Enter the base URL of the API to be used for requests, for example https://swapi.dev/api

4. Method: Post or Get.

   For example, Get for the Star Wars API.

5. Authentication: None or Basic

   For example, None for the Star Wars API.

6. Headers can be added if required.

   No header information needed for the Star Wars API.

7. Query Parameters can be added if required.

   None are needed for the Star Wars API.

8. Click Save.

This feature is deprecated. Use the new and more powerful Web API plugin. You only need to use the steps below if you added a provider before the Web API data source was available.

1. Add a new data tile and in the configuration scope the tile to SquaredUp

2. Choose the + Web API data stream.

3. Enter a name for this data stream. For example, Star Wars People

4. Select a provider from the list. For example, Star Wars.

5. Path Suffix: Choose the API method you want to call. For example, for the Star Wars API you can type people to use the People method.

6. Row Path: Enter the response path of the property you want to turn into rows. For example, for the Star Wars API type results.

7. Click Save.

8. Optionally, you can configure filtering, grouping, sorting etc as normal.

   Configure Data Stream

   Filtering

   Data can be filtered according to whether data in a column meets or does not meet specified text or numerical value conditions. Depending on the data you are filtering, available options include: Equals, Not equals, Contains, Doesn't contain, Less than, Greater than, Before now, After now, Is empty, Is not empty.

   Dates can be filtered by Before now or After now (e.g. to show overdue orders). Text matching is case sensitive.

   You are able to add multiple filter conditions. Available options are:

   • AND – all conditions must be satisfied (e.g. Status-Equals-ClosedAND Type-Equals-Question).

   • OR – any condition can be satisfied (e.g. Status-Equals-PendingOR Status-Equals-Closed).

   Grouping

   You can group and aggregate data by column.

   For example, for AWS cost data you might Group bylabel, choose Aggregation typeTotal with Aggregation columnAmount, to show a table or bar chart of cost per label.

   Which columns are available depends on the data stream you chose.

   Configuring grouping will enable different visualizations to be displayed, such as bar chart and donut. For example, grouping tickets by channel will allow you to show a donut of how many tickets were logged by email vs web form.

   Bucket by

   If you group by a time column, and further grouping is possible, then the Bucket by dropdown will appear, which allows you to control how the time data is grouped, for example by hour, day, month etc.

   Aggregation type and column

   Using this dropdown you can choose how to summarize your data, for example as a count, average or total.

   For example, for a Bar Chart of ticket data you might Group by Date created, choose Bucket byDay with Aggregation type Count, to show a line graph of tickets per day. Or for a Bar Chart of Azure Resource Group cost you might Group byTimestamp, Bucket byDay, Aggregation typeTotal and Aggregate columnCost.

   Sorting

   Data can be sorted by column in ascending or descending order. This sets the default sort order, but users can click on a column heading to sort data in a table on the fly.

   Ticking Top and typing a number will show the top n rows of data.

9. You can also add Monitors or KPIs, as you would for any tile.