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.
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.
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. If this process fails, see Testing and troubleshooting for assistance with the corresponding errors.
Testing and troubleshooting
The table below lists the errors you may encounter when testing the data source and describes how to resolve them.
Next steps
Sample Dashboards
Sample dashboards are designed to get you up and running quickly with ready-made dashboards, tailored to each plugin.
The following sample 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
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").
This data stream calls the /report/{reportId}/results.json endpoint.
- Scope to a Pendo Report
- Select Pendo Report from the data stream list
This data stream calls the /aggregation endpoint.
- Scope to a Pendo Organization.
- Select + Number of Visitors.
- Enter a Display Name for the new data stream.
- Enter a Pendo Segment Id.
This data stream calls the /aggregation endpoint and allows you to enter a custom Pendo aggregation query.
- Scope to a Pendo Organization.
- Select + Custom Aggregation Query.
- Enter a Display Name for the new data stream.
- Enter Aggregation Query, for example:
{ "requestId": "account-list", "pipeline": [ { "source": { "accounts": null } } ] }