This allows you to query data from third-party APIs and present that data on a dashboard. You can add details of providers to use with the Web API data stream from Settings > Web API > Providers.
Adding a Provider
Browse to Settings > Web API > Providers and click Add new provider.
Enter a name for the provider, for example
Enter the base URL of the API to be used for requests, for example
Method: Post or Get.
For example, Get for the Star Wars API.
Authentication: None or Basic
For example, None for the Star Wars API.
Headers can be added if required.
No header information needed for the Star Wars API.
Query Parameters can be added if required.
None are needed for the Star Wars API.
Adding Web API data to a dashboard
Add a new tile and in the configuration scope the tile to SquaredUp
Choose the + Web API data stream.
Enter a name for this data stream. For example, Star Wars People
Select a provider from the list. For example, Star Wars.
Path Suffix: Choose the API method you want to call. For example, for the Star Wars API you can type
peopleto use the People method.
Row Path: Enter the response path of the property you want to turn into rows. For example, for the Star Wars API type
Optionally, you can configure filtering, grouping, sorting etc as normal.Configure Data Stream
Advanced settings for each data stream can be found by clicking Configure next to the data stream name.
Data shown can be filtered according to whether data in a column equals or does not equal a specified text or numerical value. Dates can be filtered by Before now or After now, for example to show overdue orders. Text matching is case sensitive.
You can group and aggregate data by column.
For example, you might Group by
service, choose to Aggregate column
amountwith Aggregation type
Total, to show a table of cost per service.
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.
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.
- You can also add Monitoring or KPIs, as you would for any tile.