Pendo plugin

Visit our website to see the data that you can access if you use this plugin to add the data source to SquaredUp:

Pendo

Visualize your Pendo report data and custom aggregation queries.

How to add a Pendo data source

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 data source to SquaredUp

1. 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.

2. Display Name:

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

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

4. Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.

   Restrict access to this data source

   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.

   Data source access levels

   Access Level:

   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.

5. Click Test and add to validate the data source configuration.

   Testing outcomes

   • Testing passed – a success message will be displayed and then the configuration will be saved.

   • Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.

   • Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.

   You can edit any data source configurations at any time from Settings > Data Sources.

   You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.

Using the Pendo data streams

What is a data stream?

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").

Data streams installed with the data source see Using the Pendo Reports data stream

How to create a data stream for this data source:

• Create a data stream using the configurable data stream see Creating a data stream using the configurable data streams

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

Creating a data stream using the configurable data streams

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 cog icon next to their name in the tile editor.

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.

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
      }
  }
  ]
}