Skip to main content

Intro

Pendo captures user behavior, gathers feedback and provides contextual help beyond your service or platform. To learn more about the Pendo API, visit their page (https://help.pendo.io/resources/supp…dev/index.html ). You connect to your Pendo account in the Data Center. This topic discusses the fields and menus that are specific to the Pendo connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Connector.

Prerequisites

To connect to your Pendo account and create a DataSet, you must have a Pendo integration key. You can generate an integration key by doing the following:
  1. Log into Pendo.
  2. Click your username.
  3. Select Integration Keys.
  4. Select Add Integration Key.
  5. Name your new key.

Connecting to Your Pendo Account

This section enumerates the options in the Credentials and Details panes in the Pendo Connector page. The components of the other panes on this page, Scheduling, and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Connector.

Credentials Pane

This pane contains fields for entering credentials to connect to your Pendo account. The following table describes what is needed for each field:

Field

Description

Integration Key

Enter your Pendo integration key. For information about generating a key, see “Prerequisites,” above.

Region

Select the region from the drop-down list.

Once you have entered valid Pendo credentials, you can use the same account any time you go to create a new Pendo DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Manage Connector Accounts.

Details Pane

This pane contains a primary Reports menu, along with various other menus which may or may not appear depending on the report type you select.

Menu

Description

Report

Select the report you want to run. The following reports are available:

Report Name Description
Contents of Reports Returns the contents of a selected Pendo report.
Get Change History for Guide Returns the change history for a specified guide.
Guides Seen Returns the Change History for Guide.
Row Aggregation Returns row aggregation data for a given source and timeframe.
Public Reports Returns a list of public Pendo reports.
Pendo Report Select the Pendo report you want to pull into Domo.
Source

Select the desired source for the Row Aggregation report. The following table describes the available sources:

Source Description Date Filter Field
Accounts The accounts your users (usually your customers) belong to. metadata.auto.lastvisit
Custom Lets you define your own request JSON in the Custom Aggregation field. For more information, see http://help.pendo.io/resources/suppo…w-sources.html . You define your own
Events All recorded click and pageview events (tagged or untagged). timeSeries dayRange
Features Sets of rules that identify individual product features (defined by a DOM rule). lastUpdatedAt
Feature Events All recorded click events matching tagged features. timeSeries dayRange
Guides The in-app messages you show visitors. lastUpdatedAt
Pages Sets of rules that idenfity individual pages in your product (defined by a URL rule). lastUpdatedAt
Page Events All recorded pageviews matching tagged pages. timeSeries dayRange
Visitors Your product’s users (including internal users who access customer accounts). metadata.auto.lastvisit

Guide ID Enter the ID of the guide you want to retrieve information for. To find the ID for a desired guide, navigate to the page for that guide (from the Guides page in Pendo), then copy the last portion of the URL. For example, in the URL https://app.pendo.io/guides/abcd_xyz1234 , the guide ID would be abcd_xyz1234 .
Poll ID Enter the Poll ID to get the details for a specific poll.
Guide Step ID Enter the Guide Step ID to get the details for a specific guide or step.
Custom Aggregation Enter the request json. For example:
{
   "pipeline": [
      {
      "limit": 5
      }
   ],
   "source": {
      "pageEvents": null
   },
   "timeSeries": {
      "count": 1,
      "first": 1493596800000,
      "period": "dayRange"
   }
}

Specifying dates - Common examples:
'now()', 'date(yyyy,MM,dd)', '1693540800000' (epoch timestamp), 'yyyy-MM-dd'
All Guides Select ‘Yes’ if you wish to query for all guides. ‘No’ to select specific ones.
Guides Select the guides to query.
Do not hash the Visitor ID? Select this checkbox to NOT use hashing for the visitor ID, by default.
Application Id Selection Type Select whether to retrieve data from all or only specific application id.
Enter Application IDs Enter the Application ID for which we need to retrieve the data.
Handle Records

This field appears when you select the Row Aggregation report and the source as Guides .

If you encounter an error when the columns exceeds the allowed limit, you can use one of the following options to handle the records.

None – This option is selected by default. It does not handle the error when the column exceeds the specified limit.

Skip Step_Translations Data – The stepTranslations data will be skipped and not added to the dataset.

Handle Step_Translations Data – The data will be flattened to reduce the row count.

Duration (GMT) Select the duration for the report (a Single Date, or a Date Range).
Report Date Select the report date using relative or specific dates. Relative indicates the number of days from today or a specific date using the date selector.
Select Specific Date Select the report date using the date selector.
Days back The number of days back that you would like to get data for. Specify either today or 0, yesterday or 1, or today-7 or 7 to get data for 7 days into the past.
Start Date Select the report start date using relative or specific dates. Relative indicates the number of days from today or a specific date using the date selector.
Select Specific Start Date Select the report date using the date selector.
Days back to start from The number of days back that you would like to get data from (start day). Specify either today or 0, yesterday or 1, or today-7 or 7 to get data for 7 days into the past.
End Date Select the report end date using relative or specific dates. Relative indicates the number of days from today or a specific date using the date selector.
Select Specific End Date Select the report date using the date selector.
Days back to end at The number of days back that you would like to get data to (end day). Specify either today or 0, yesterday or 1, or today-7 or 7 to get data for 7 days into the past.
Use Report Schema Select the checkbox if you want to have report schema as column names.

Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Connector.