Guide elements metrics via the API

Follow

Angela Holly

• April 26, 2022 16:46
• Edited

You can easily see metrics for Guide elements via the UI in Pendo as described here: https://support.pendo.io/hc/en-us/articles/360031864592-Guide-Details-Metrics-Visual-Designer-#GuideElements

If you want to get the same information via API, you'll need to use the aggregation endpoint (https://app.pendo.io/api/v1/aggregation), and use the guideEvents source. When reviewing the responses, look for "type": "guideActivity". 

Below is an example showing a click on the dismiss button for a guide:

{   "accountIds": [     "New Account"   ],   "browserTime": 1643942917018,   "country": "BR",   "elementPath": "BODY",   "eventId": "",   "type": "guideActivity",   "guideId": "jw9pNRN8kxhQmEbRNkjQKOUTHJM",   "guideStepId": "AOGX37n3jQrnmBt7L1kbSDNh208",   "language": "en-US",   "latitude": -29.683463,   "loadTime": 0,   "longitude": -51.133747, "oldVisitorId": "lang:en-US elementid:pendo-close-guide-4fedae78 elementtype:BUTTON elementtext:w5c= elementactions:W3si...",   "region": "rs",   "remoteIp": "EXAMPLEIP",   "serverName": "example.github.io", "title": "ChUiE3N0b2ZmZXJfd...",   "uiElementId": "pendo-close-guide-4fedae78",   "uiElementType": "BUTTON",   "uiElementText": "×",   "uiElementActions": "[{\"action\":\"dismissGuide\"}]",   "url": "EXAMPLEURL",   "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.2 Safari/605.1.15",   "visitorId": "_PENDO_T_ciOZfuPzhJZ",   "appId": -323232,   "accountId": "New Account" }

 

0

• 

  Angela Holly

  • May 05, 2022 17:23

  Below is another example response for a guide step with two buttons. You can tell which button the visitor clicked on by either looking at "uiElementText" or "uiElementId" 

  
  
  
  
  

  
  
  {
                      "accountIds": [
                          "EXAMPLEACCOUNT"
                      ],
                      "browserTime": 1644420324536,
                      "country": "US",
                      "elementPath": "BODY",
                      "eventId": "",
                      "type": "guideActivity",
                      "guideId": "vjBC7D3XwP0dZ6hyYkVQ6am58NY",
                      "guideStepId": "L-Wr-xE5oIsb_fvaKx9bxQOGUoc",
                      "language": "en-US",
                      "latitude": 35.77959,
                      "loadTime": 0,
                      "longitude": -78.638179,
                      "oldVisitorId": "lang:en-US elementid:pendo-button-047f7a88 elementtype:BUTTON elementtext:WWVzLCBsZXQncyBnbyE= elementactions:W3siYWN0aW9uIjoib3BlbkxpbmsiLCJ0YXJnZXQiOiJfc2VsZiIsInVybCI6Imh0dHBzOi8vdG90aGVhbmdlLmdpdGh1Yi5pby9idXR0b25zLmh0bWwifSx7ImFjdGlvbiI6ImFkdmFuY2VHdWlkZSJ9XQ==",
                      "region": "nc",
                      "remoteIp": "2600:1700:4f30:9730:6915:921d:75e9:9019",
                      "serverName": "exampleserver.github.io",
                      "title": "CgoiCGFsaF9kZW1vEikKCkd1aWRlR3JvdXAaG3ZqQkM3RDNYd1AwZFo2aHlZa1ZRNmFtNThOWRIoCglHdWlkZVN0ZXAaG0wtV3IteEU1b0lzYl9mdmFLeDlieFFPR1VvYw",
                      "uiElementId": "pendo-button-047f7a88",
                      "uiElementType": "BUTTON",
                      "uiElementText": "Yes, let's go!",
                      "uiElementActions": "[{\"action\":\"openLink\",\"target\":\"_self\",\"url\":\"https://exampleserver.github.io/buttons.html\"},{\"action\":\"advanceGuide\"}]",
                      "url": "http://exampleserver.github.io/index.html",
                      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.80 Safari/537.36",
                      "visitorId": "examplevisitor",
                      "appId": 5731131925331968,
                      "accountId": "exampleaccount"
                  }

  0

  Comment actions Permalink

Please sign in to leave a comment.