Pendo plugin

For more information about what this plugin does and the data streams it retrieves, see:

Visualize your Pendo report data and custom aggregation queries.

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.

You can also add a data source by clicking Add data source on the Settings > Data Sources page, but pre-built dashboards are not added when using this method.

Before you start

To add a Pendo plugin in SquaredUp you must provide an integration key to gain secure access to information about your Pendo users and accounts.

This key must be created in Pendo by an admin user, see Pendo: Authentication.

Once created, copy the integration key so that you can easily paste it when you configure the data source.

Configuring the data source

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

Restrict access to this data source:
You can enable this option if you only want certain users or groups to have access to the data source, or 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 Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.
- 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.

Testing and troubleshooting

The table below lists the errors you may encounter when testing the data source and describes how to resolve them.

Error Message	What to do
Bad request. Please contact support.	This is a type 400 error. Check that your Pendo instance is not down, then contact support.
Unauthorized. Please check your integration key.	This is a type 401 error. Please check that your integration key is valid and has enough right to read Pendo data. If necessary, recreate the key in Pendo.
Forbidden. Please check your integration key.	This is a type 403 error. Please check that your integration key is valid and has sufficient permissions to read Pendo data. If necessary recreate the key in Pendo.
Not found. Please contact support.	This is a type 404 error. Check that your Pendo instance is not down, then contact support.
Pendo Temporary Server error. Please try again later.	This is a type 429 or 503 error. Your Pendo instance is not accessible. When the problem is resolved, try again.
Pendo Internal Server Error. If this condition persists, please contact support.	This is a type 500, 429 or 503 error. Your Pendo instance is not accessible. When the problem is resolved, try again.

Next steps

Dashboards

Pre-built dashboards are designed to get you up and running quickly with ready-made dashboards, tailored to each plugin.

The following dashboards are installed with this plugin:

Account Report: Lets you choose an account report and see its data to customize key metrics you would like to visualize for your selected report
Visitor Report: Lets you choose a visitor report and see its data to customize key metrics you would like to visualize your selected report

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.

Data stream	Description
Pendo Report	Get the content of a Pendo report

Configurable data streams

The following data streams have configurable Parameters.

Data stream	Description	Parameters
Custom Aggregation Query	Create and execute custom Pendo aggregation query	Custom aggregation query: Enter an aggregation query, for example: `{ "requestId": "account-list", "pipeline": [ { "source": { "accounts": null } } ] }`
Number of Visitor Accounts	Get the number of visitor accounts for a given segment and period	Segment Id: Enter a segment Id to return.

Was this article helpful?

Have more questions or facing an issue?

Submit a ticket