Web API plugin

The Web API plugin allows you to query data from any HTTP API that returns JSON, and then visualize that data. This is particularly useful if there isn't a SquaredUp plugin available for your data source.

Click the following link for additional content such as blogs, videos, use cases, and more:

Web API

Adding a data source

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

Before you start

Will SquaredUp need to connect to this data source via a relay agent?
Configure the data source in SquaredUp

Will SquaredUp need to connect to this data source via a relay agent?

This plugin is a hybrid plugin, meaning it can connect to either a cloud or an on-prem data source.

If your data source is available on the internet, then you do not need to connect via a relay agent.
If your data source is on a private network and is not publicly accessible, then you will need to configure a relay agent before you configure the plugin. See Deploying a relay agent.

This feature is available with an Enterprise plan

Relay agents allow you to securely connect to data sources inside your own network (on-prem).

A relay agent is installed on a server on your internal network, and has access to your data source.

When a plugin uses a relay agent it means that you don't need to open your firewall to allow SquaredUp access to the data source.

If you have already created a relay agent in SquaredUp that can access this data source, then you can skip this step and choose Connect via relay agent when Configuring the data source.

Configuring the data source

For testing you could use the JSON Placeholder API. This is a JSON REST API that will show you some sample data: http://jsonplaceholder.typicode.com

Display name:
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.

For example: JSON Placeholder
Connect via relay agent
If you are connecting to an on-prem data source then select this toggle, so you can use a relay agent to connect securely.
Agent group:
Select the Agent Group that contains the agent(s) you want to use. Agent groups are managed from Settings > Relay Agents
Base URL:
Enter the base URL of the API to be used for requests.
For example you could use http://jsonplaceholder.typicode.com For this sample API the provider needs no further configuration so just click Add and then go to Show data on a tile.
Query arguments:
Optionally, add any parameters that should be added to the Base URL. You may prefer to add these in the tile configuration so you can use different queries on different tiles.
Authentication:
- None: No authentication required.
- Basic: You must enter a Username and Password.
- OAuth 2: Token-based authentication according to the OAuth 2.0 standard. Many APIs use OAuth 2.0 for authorization, and will require an OAuth provider to include the additional information about how to authorize against the service. If this option is selected, follow the steps in Configure OAuth 2.0 below.
  Specify the details for your required OAuth 2.0 flow. For more detailed information see OAuth 2.0 Configuration.
  1. Token URL:
    Enter the URL of the third-party authentication server you are using. For example, https://oauth2.googleapis.com/token.
  2. Client ID:
    Enter the ID provided by your client application.
  3. Client Secret:
    Enter the secret provided by your client application.
  4. Authorization Scope:
    Enter your required access scopes for the third-party application server you are using. For example, if you are using the Web API plugin to access the https://www.googleapis.com/ API and you wish to use the drive/v3/files endpoint, you can use the authorization scope https://www.googleapis.com/auth/drive.readonly.
    If you require more than one scope, you add them all here separated by spaces.
    The Web API plugin requires offline access to be requested, which requires the correct scope to be entered, dependent on the authentication server being used:
    Atlassian: Request the offline_access scope.
    Google APIs: Offline access isn't requested via a scope at all. Instead, you must add the access_type = offline and include_granted_scopes = true query arguments to the Authorization URL.
  5. How to send credentials to the Token URL:
    Select where you want the client credentials you entered above to be included in the OAuth 2.0 request.
  6. Grant Type:
    Select the OAuth 2.0 flow you need to use. Choose from:
    Authorization Code: Enter the Authorization URL of the authorization server you are using (for example, https://www.googleapis.com/) and then click the Sign In button below. You are redirected to the authorization sign in page.
    Upon returning to SquaredUp , if the request was successful, the Sign In button shows you as logged in.
    Client Credentials: No additional details are required.
    Password: You must enter a Username and Password.
  7. If you need to send the authorization token in the query URL, select Send authorization with query.
Headers can be added if required.
Ignore certificate errors:
If you activate this checkbox the data source will ignore certificate errors when accessing the server. This is useful if you have self-signed certificates.
Test endpoint:
Optionally, you can tick Test endpoint to run a test request and see an example payload.
Enter the details of an endpoint you'd like to run a test against to see what is returned. The information entered here is only used for the test.
1. Endpoint path to test:
  Enter an endpoint path.
2. Additional headers for the test:
  Enter any additional header names and values to be used for the test.
3. HTTP method for the test:
  GET or POST
4. Query arguments for the test GET:
  If you chose GET you can optionally add any query arguments to be used for the test.
5. Body for test POST:
  If you chose POST you can optionally enter a JSON string representing the body of the POST request.
6. Click Send.
7. The Result box will show the resulting payload.

Restrict access to this data source:
Optionally, enable this toggle if you only want certain users/groups to have access to the data source, or those with the permission to link it to new workspaces. See data source access control for more information.

The term data source here really means data source instance. For example, a user may configure two instances of the AWS data source, one for their development environment and one for production. In that case, each data source instance has its own access control settings.

By default, Restrict access to this data source is set to off. The data source can be viewed, edited and administered by anyone. If you would like to control who has access to this data source, switch Restrict access to this data source to on.

Use the Restrict access to this data source dropdown to control who has access to the workspace:

By default, the user setting the permissions for the data source will be given Full Control and the Everyone group will be given Link to workspace permissions.
Tailor access to the data source, as required, by selecting individual users or user groups from the dropdown and giving them Link to workspace or Full Control permissions.
If the user is not available from the dropdown, you are able to invite them to the data source by typing in their email address and then clicking Add. The new user will then receive an email inviting them to create an account on SquaredUp. Once the account has been created, they will gain access to the organization.
At least one user or group must be given Full Control.
Admin users can edit the configuration, modify the Access Control List (ACL) and delete the data source, regardless of the ACL chosen.

Access level	Permissions
Link to workspace	User can link the data source to any workspace they have at least Editor permissions for. Data from the data source can then be viewed by anyone with any access to the workspace. User can share the data source data with anyone they want. User cannot configure the data source in any way, or delete it.
Full Control	User can change the data source configuration, ACL, and delete the data source.

See Access control for more information.

Click Add.

Next steps

Data streams

You can use these data streams to create new tiles to show data, or if there are preconfigured dashboards installed you can copy or edit those.

Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format.

While creating a tile you can tweak data streams by grouping or aggregating specific columns.

Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.

Data streams can be either global or scoped:

Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").

See Data Streams for more information.

The following data streams are installed with this plugin.

HTTP Request

Makes an HTTP request on the specified path

Parameters

Configuring a Web API tile

The following information walks you through the process of configuring a data tile using the Web API data source.

See Web API data stream parameters for examples and for detailed information about each configuration settings.

On a dashboard click + and select Data to open the tile editor.
Configure the Data Stream tab:
1. Select HTTP Request.
2. If you only have one Web API data source configured the object is automatically selected and you can continue to the Parameters tab. Otherwise, select the Objects tab.
Configure the Objects tab:
1. Select the object with the same name that you gave your Data Source. If you are using the JSON Placeholder API for sample data then this might be JSON placeholder.
2. Select the Parameters tab.

Configure the Parameters tab. This tab is composed of several sub-tabs responsible for configuring each part of the HTTP request. Complete each one as follows:

Basics:
Use this sub-tab to configure the request method and endpoint URL of the request. The Base URL you configured in the Data Source setup is automatically populated in the address (unless you are using a Collection with more than one base URL). Depending on your API, you may see data at this point, or you may need to carry out some further configuration.

Method:
Select GET or POST from the dropdown to the left of the URL.

Enter a path:
Optionally, enter an endpoint path after the URL. For the JSON Placeholder API you might enter /posts or /todos.

A mustache parameter is a dynamic value, the actual value will be inserted to replace the field in curly braces. For example, {{timeframe.start}} will insert the start time based on the timeframe configured within the tile, or {{name}} will insert the name of the object(s) in scope.

This data stream supports timeframe parameters:

Parameter	Replacement value	Type
{{timeframe.start}}	2022-03-13T19:45:00.000Z	string
{{timeframe.unixStart}}	1647200700	number
{{timeframe.end}}	2022-03-14T19:45:00.000Z	string
{{timeframe.unixEnd}}	1647287100	number
{{timeframe.enum}}	last24hours	string
{{timeframe.interval}}	PT15M	string
{{timeframe.durationSeconds}}	86400	number
{{timeframe.durationMinutes}}	1440	number
{{timeframe.durationHours}}	24	number

For the JSON placeholder API a suitable visualization is shown at this point, and further configuration is optional.

Click Apply to update the URL and resend the request.

Body:
If you chose the POST method, optionally enter a JSON string representing the body of the POST request.

This data stream supports timeframe parameters:

Parameter	Replacement value	Type
{{timeframe.start}}	2022-03-13T19:45:00.000Z	string
{{timeframe.unixStart}}	1647200700	number
{{timeframe.end}}	2022-03-14T19:45:00.000Z	string
{{timeframe.unixEnd}}	1647287100	number
{{timeframe.enum}}	last24hours	string
{{timeframe.interval}}	PT15M	string
{{timeframe.durationSeconds}}	86400	number
{{timeframe.durationMinutes}}	1440	number
{{timeframe.durationHours}}	24	number

Parameters:
Optionally, add any query arguments to be used.

This data stream supports timeframe parameters:

Parameter	Replacement value	Type
{{timeframe.start}}	2022-03-13T19:45:00.000Z	string
{{timeframe.unixStart}}	1647200700	number
{{timeframe.end}}	2022-03-14T19:45:00.000Z	string
{{timeframe.unixEnd}}	1647287100	number
{{timeframe.enum}}	last24hours	string
{{timeframe.interval}}	PT15M	string
{{timeframe.durationSeconds}}	86400	number
{{timeframe.durationMinutes}}	1440	number
{{timeframe.durationHours}}	24	number

Headers:
Optionally, click Add new header to enter any additional header names and values to be used. You can choose to encrypt a Header Value by clicking the encrypt icon

. This turns the field into a password field, so that the value is hidden and the data is stored as encrypted.

This data stream supports timeframe parameters:

Parameter	Replacement value	Type
{{timeframe.start}}	2022-03-13T19:45:00.000Z	string
{{timeframe.unixStart}}	1647200700	number
{{timeframe.end}}	2022-03-14T19:45:00.000Z	string
{{timeframe.unixEnd}}	1647287100	number
{{timeframe.enum}}	last24hours	string
{{timeframe.interval}}	PT15M	string
{{timeframe.durationSeconds}}	86400	number
{{timeframe.durationMinutes}}	1440	number
{{timeframe.durationHours}}	24	number

Response:
Click Send to fire off the HTTP request. The returned payload displays in the Response box (unless you are using a Collection with more than one base URL).
1. Select data:
  Enter a Path or a Script to define the location of the results you want in the JSON response. You can click Send on the Response sub-tab for the location of the data returned, and use that to determine the path.
Select the Timeframe tab.

Configure the Timeframe tab:
Optionally, you can specify a timeframe here, but you may have specified a set timeframe in the query or endpoint path.
At this point you might like to configure the visualization, see Visualization Settings.
For the JSON placeholder sample data you could choose Donut.
The Shaping and Columns sections can help you configure the visualization as you need.
Configure the Shaping tab:
Shaping allows you to perform filtering, grouping and sorting operations on the data you retrieve, although you may also do this using your query.
Configure the Columns tab:
Column configuration allow you to change the shape of your data and apply format or value expressions.
Optionally, configure Monitoring and KPIs.
Click Save when you have finished.

Advanced users

A custom data stream is a data stream that you, as an advanced user, can write yourself.

Any data stream you create can be edited by clicking the edit button (pencil) next to it in the tile editor, and also from Settings > Advanced > Data Streams.

You may wish to create your own custom data stream for an HTTP Request using the information below. When writing your own data stream you can choose either a global or scoped entry point. You will need to write your own custom data stream if you want a scoped data stream, because the configurable data stream HTTP Request can only create a global data stream.

In SquaredUp, browse to Settings > Advanced > Data Streams.
Click Add custom data stream.
Add your custom data stream by entering the following settings:
1. Name:
  Enter a display name for your data stream.
  The display name is the name that you use to identify your data stream in SquaredUp. It has no technical impact and doesn't need to be referenced in the data stream's code.
2. Data source:
  Choose the data source this data stream is for.
  After you've chosen the data source the Entry Point field displays.
3. Entry Point:
  Specify the data stream entry point and enter the Code below.
  Each data stream uses an entry point, which can either be global (unscoped) or scoped, and this determines whether the data stream uses the tile scope.
  Data streams can be either global or scoped:
  - Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
  - A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").
  To find out which entry point to select and get code examples for the Code field, see the help below.
Click Save to save your data stream.

Creating a custom data stream allows you to created a scoped data stream, i.e. a data stream that makes use of objects in the scope.

Which entry point do I have to select from the dropdown?

HTTP Request (scoped)

Each data stream uses an entry point, which can either be global (unscoped) or scoped, and this determines whether the data stream uses the tile scope.

Data streams can be either global or scoped:

Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").

Code example:

{
	"name": "scope example",
	"matches": "all",
	"dataSourceConfig": {
		"endpointPath": "post",
		"httpMethod": "post",
		"idSeparator": "], [",
		"headers": [
			{
			"key": "header1",
			"value": "header1Val"
			},
			{
			"key": "sourceIds",
			"value": "[{{sourceIds}}]"
			}
		],
		"expandInnerObjects": true
	},
	"rowPath": []
}

You should set the matches statement so that your custom data stream appears when you select the appropriate object types in the tile editor. You can use additional mustache constructs when using the scoped entry point: targetNodes, sourceId, sourceIds in selected dataSourceConfig parameters as shown below. The separator inserted between sourceId values in the sourceIds replacement string can be changed by setting idSeparator in dataSourceConfig.

Parameters

Mandatory

The internal name of the data stream. Can be used the refer to this data stream in a tile's JSON instead of using the data stream's internal ID.

`endpointPath`	Mandatory	(string) - the endpoint path relative to the data source config's base URL to be queried (supports mustache parameters)
`httpMethod`	Mandatory	(string) - "get" or "post"
`headers`	Optional	(array of key, value pairs) - any additional headers for this request (supports mustache parameters in `value` only)
`getArgs`	Optional	(array of key, value pairs) - any additional query args (supports mustache parameters in `value` only)
`postBody`	Optional	(string) – only if httpMethod is "post", a JSON string defining the body (supports mustache parameters)
`idSeparator`	Optional	(string) - this controls how the replacement value "sourceIds" is generated
`pathToData`	Optional	(string) - where in the returned payload, the desired data is to be found
`expandInnerObjects`	Optional	(boolean) - whether to expand inner objects and arrays in the desired data

Note: Defining the matches parameter is mandatory.

With the matches parameter you define for which objects the data stream will be shown in SquaredUp. It works like this:
When you configure a tile, you have to choose its scope. If this scope contains objects you specified here in the matches parameter, the data stream will be shown in SquaredUp under Data Streams. If the scope doesn't contain objects specified here, the data stream will be hidden.
This keeps things clean and simple since you'll only see the data stream when it's relevant for the scope you chose. As a best practice you should limit the data stream to objects that make sense for the specific use case of this data stream.

Format for matches:

//If you want to specify only one value of an object property//
"matches": {
	"ObjectProperty": {
		"type": "equals",
		"value": "ValueOfTheObjectProperty"
	}
},
 
//If you want to specify multiple values for an object property//
"matches": {
	"ObjectProperty": {
 		"type": "oneOf",
		"values": ["ValueOfTheObjectProperty1", "ValueOfTheObjectProperty2", "ValueOfTheObjectProperty3"]
	}
},

Example for limiting a data stream to objects:

If you are using multiple values for the object property, you can decide if you want the data stream to be visible for objects that match all of the criteria or at least one of the criteria.

Lets say you have two values you want objects to have in order for the data stream to be visible for them:

a SourceName property with the value AppDynamics (meaning objects that come from the AppDynamics data source)
a type property with the value app (meaning application objects)

If you want the data stream to be visible only for objects that match both of the criteria, your code would look like this:

"matches": {
    "sourceName": {
      "type": "equals",
      "value": "AppDynamics"
    },
    "sourceType": {
      "type": "equals",
      "value": "app"
    }
  },

If you want the data stream to be visible for objects that match at least one of the criteria, your code would look like this:

"matches": [
    {
        "sourceName": {
            "type": "equals",
            "value": "AppDynamics"
        }
    },
    {
        "sourceType": {
            "type": "equals",
            "value": "app"
        }
    }
]

Note: If you run into errors when configuring the matches parameter, check if you're dealing with a global entry point.

Data streams can be either global or scoped:

Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").

Global entry points can't use specific objects in the matches parameter. You can identify global entry points by their name, they have "Global", "No Scope" or "Unscoped" added to their name.

There are two possible options for the matches parameter for global entry points:

`"matches": "none",`	When creating a tile, the Data Stream will be shown as long as no scope is selected. As soon as a scope is selected, the Data Stream will be hidden.
`"matches": "all",`	When creating a tile, the Data Stream will be shown as soon as any scope is selected.

Optional

SquaredUp expects data in table form, and here's where you define how the table with your return data will be structured.

The rowpath (Path to data) will tell SquaredUp which items you want to convert into rows.

Example:

Let's say your return data looks like this:

{
    "generalInfo": "some info",
    "results": [
        {
            "name": "object 1",
            "tags": [
                "tag 1",
                "tag 2",
                "tag 3"
            ]
        },
        {
            "name": "object 2",
            "tags": [
                "tag 1",
                "tag 4"
            ]
        }
    ]
}

Now it depends on what data you want to base your table on, do you want rows per object or per tag?

If you want to see which objects have which tags, your rowpath would be results, and your table would look like this:

`name`	`tags`
object 1	tag 1, tag 2, tag 3
object 2	tag 1, tag 4

If you want to turn each tag into a row and see to which objects they are applied, your rowpath would be results.tags, and your table would look like this:

`tags`	`name`
tag 1	object 1
tag 1	object 2
tag 2	object 1
tag 3	object 1
tag 4	object 2

As you can see in the example, each parameter gets turned into a column and the items of the parameter you chose as the rowpath will be turned into rows.

Optional, but recommended

The metadata parameters are used to describe columns in order to tell SquaredUp what to do with them. You can do multiple things with the metadata parameters:

Specify how SquaredUp should interpret the columns you return and - to an extent - how their content displayed. You do this by giving each column a shape.
The shape you assign to a column tells SquaredUp what the column contains (for example, a number, a date, a currency, a URL, etc.). Based on the shape SquaredUp decides how to display this column, for example to display a URL as a clickable link.
Filter out or just hide columns.
Only the columns you define in metadata will be returned in the results. This helps you to filter out columns you don't need. If you need the content of a column but don't want to display it, you can use the visible parameter.
Give columns a nicely readable display name.
Assign a specific role to columns .
The role you assign to a column tells SquaredUp the purpose of the column. For example, if you have two different columns that contain numbers, you need to assign the role value to the column that contains the actual value you want to use in your visualization.

If you don't specify any metadata, all columns will be returned and SquaredUp will do its best to determine which columns should be used for which purpose. If you're returning pretty simple data, for example just a string and a number, this can work fine. But if you're returning two columns with numbers it gets trickier for SquaredUp to figure out which one is the value and which one is just an ID or some other number.

Parameters:

Before you start specifying metadata, leave them empty at first and get all the raw data with your new data stream once.

In order to do this, finish creating your custom data stream without metadata and create a tile with this data stream. The Table visualization will show you all raw data.

This will give you an overview about all columns and their content and help you decide which columns you need and what their shapes and roles should be. It's also essential for getting the correct column name to reference in the name parameter.

Use this information to go back to the data stream configuration and specifying the metadata.

`name`	Mandatory	Enter the name of the column you are referencing here. To find the name of a column, get the data from this data stream once without any metadata. See the tip above for how to do that. You'll see the column name when you hover over the column in the Table.
`displayName`	Optional	Here you can give the column a user-friendly name
`shape`	Recommended	The shape you assign to a column tells SquaredUp what the column contains (for example, a number, a date, a currency, a URL, etc.). Based on the shape SquaredUp decides how to display this column, for example to display a URL as a clickable link. Note: Please refer to the list of shapes below this table to see available shapes.
`role`	Recommended	The role you assign to a column tells SquaredUp the purpose of the column. For example, if you have two different columns that contain numbers, you need to assign the role `value` to the column that contains the actual value you want to use in your visualization. Note: Please refer to the list of roles below this table to see available roles.
`visible`	Optional	`true` or `false` Use this if you need a columns content but don't need to display the column itself. Example: Column A contains the full link to a ticket in your ticket system. Column B contains the ticket ID. You want to use the ticket ID as a label for the link, turning the long URL into a much nicer to read "Ticket 123". This is why you need the content of column B, to assign it as a label for column A. But since the URL is now displayed as the ticket ID, it would be redundant to still display column B. This is why you hide column B with `false`.

There are many different shapes you can use for your columns and the list of possible shapes gets expanded constantly:

Basic types, like: boolean, date, number, string
Currency types that get displayed with two decimal values and their currency symbol (for example $23,45), like: currency (generic currency), eur, gbp, usd
Data types, like: bytes, kilobytes, megabytes
Time types, like: seconds, milliseconds, timespan
The status type : state
Utility types, like:
customUniturl (will be displayed as a link)

Tip:

Some shapes can be configured.

If a shape is configurable, you can edit how the shape displays data in SquaredUp.

See Configurable shapes

`id`	Used by data streams feeding the aggregate health stream to identify their Id column
`label`	A column containing user-friendly names. Line Graphs use this role to group data into series. so each label will get its own line in the Line Graph.
`link`	A column containing a link that can be used as a drilldown in Status Blocks.
`timestamp`	A column containing a date to use on the X -axis of a Line Graph.
`unitLabel`	A column containing user-friendly labels for data series, e.g. ‘Duration’. Line Graphs can use this role to label the Y-axis.
`value`	A column containing the numeric value you want to use in your visualization.

Was this article helpful?

Have more questions or facing an issue?

Submit a ticket

Web API plugin

HTTP Request

Was this article helpful?

Have more questions or facing an issue?

Related community topics