Pendo plugin

Visualize your Pendo report data and custom aggregation queries.

How to add the Pendo plugin

Create an Integration Key in Pendo

1. Create an Integration Key in Pendo, see Pendo: Authentication

2. Copy and note the Integration Key somewhere safe.

Add the Pendo plugin to SquaredUp

1. In SquaredUp browse to Settings > Plugins > Add plugin and search for the plugin.

2. Display Name:

   Enter a name for your plugin. This helps you to identify this plugin in the list of your plugins.

3. Integration Key: Enter the key you created in Pendo.

4. Leave the checkbox for Automatically create a workspace ticked, this will create a new workspace for this plugin containing out of the box dashboards and scopes.

5. Optionally, select whether you would like to restrict access to this plugin instance. By default, restricted access is set to off.

   Restrict access to this workspace?

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

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

   Use the Restrict access to this plugin? dropdown to control who has access to the workspace:

   • By default, the user setting the permissions for the plugin will be given Full Control and the Everyone group will be given Link to workspace permissions.

   • Tailor access to the plugin, 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 plugin 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 Cloud. Once the account has been created, they will gain access to the tenant.

   • 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 plugin, regardless of the ACL chosen.

   Plugin access levels

   Access Level:

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

   See Access control for more information.

6. Click Save.

Using the Pendo plugin

Data Streams

What is a data stream?

A data stream brings you data to answer a specific question like "What's the health state of the objects?", "What kind of alerts are coming from this plugin for my servers?", "What's the average memory usage of this app?"

The magic of data streams is that they 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.

There are two types of data streams available for this plugin

• Data streams installed with the plugin, see Using the Pendo Reports data stream

• Configurable data streams see Using Configurable data streams with the Pendo plugin

Using the Pendo Reports data stream

This data stream calls the /report/{reportId}/results.json endpoint.

1. Scope to a Pendo Report

2. Select Pendo Report from the data stream list

Using Configurable data streams with the Pendo plugin

What is a configurable data stream?

A configurable data stream allows you to easily create new data streams specific to your needs, by entering information into a form, such as metric names or queries. Configurable data streams have a + before the name, and once new data streams have been created they show in the normal list of data streams.

Any data streams you create can be edited from Settings > Data Streams.

Number of Visitors

This data stream calls the /aggregation endpoint.

1. Scope to a Pendo Organization

2. Select + Number of Visitors

3. Enter a Display Name for the new data stream

4. Enter a Pendo Segment Id

Custom Aggregation Query

This data stream calls the /aggregation endpoint and allows you to enter a custom Pendo aggregation query.

1. Scope to a Pendo Organization

2. Select + Custom Aggregation Query

3. Enter a Display Name for the new data stream

4. Enter Aggregation Query, for example:

{
  "requestId": "account-list",
  "pipeline": [
  {
      "source": {
          "accounts": null
      }
  }
  ]
}