Know more about Page Events records 'parameters' value.

Comments

3 comments

  • Official comment
    Avatar
    Alisyn Collins
    Hi Brian!
    The parameters field in a pageEvents response is going to depend on how you have your pages tagged within Pendo. You won't see any value there unless you're using a *parameters* tag as described here.
    Using your example of `https://www.pendosandbox.com/features/test/`, if you had your page tagged in Pendo as:
    //*/features/*parameters*
    then your API response would look something like this:
    {
    "results": [{
    "accountId": "Acme Corp",
    "visitorId": "10",
    "numEvents": 1,
    "numMinutes": 1,
    "server": "www.pendosandbox.com",
    "remoteIp": "110.227.245.175",
    "parameters": {
    "parameter": "test"
    },
    "userAgent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.113 Safari/537.36",
    "day": 1506484800000,
    "pageId": "aJ0KOADQZVL5h9zQhiQ0q26PNTM"
    }
    ]
    }



    Comment actions Permalink
  • Avatar
    Angela Holly

    To add onto what Alisyn wrote, here is some more information in pulling parameter information via the API:

    You can use the aggregations endpoint (https://app.pendo.io/api/v1/aggregation), specifically the pageEvents source. You can get aggregated data at the hour/day level. 

     

    Example call asking for events for a specific page for the previous day.

    {
       "response": {},
       "request": {
           "name": "ExampleAggregation",
           "pipeline": [
               {
                   "source": {
                       "pageEvents": {
                           "pageId": "ABC3amaLg-TNYXwkU3ht4zJh-Pg"
                       },
                       "timeSeries": {
                           "period": "dayRange",
                           "first": "now()",
                           "count": -1
                       }
                   }
               }
           ],
           "requestId": "ExampleAggregation"
       }
    }

     

    Example response excerpt. Notice how this visitor has two separate responses because of the different parameter.

    {
       "accountId": "fakeaccount1",
       "appId": -323232,
       "day": 1629788400000,
       "pageId": "ABC3amaLg-TNYXwkU3ht4zJh-Pg",
       "numEvents": 3,
       "numMinutes": 3,
       "remoteIp": "76.90.115.123",
       "server": "clientname.io",
       "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36",
       "visitorId": "fakevisitor1",
       "parameters": {
           "parameter": "helparticle-1"
       }
    },

    {
       "accountId": "fakeaccount1",
       "appId": -323232,
       "day": 1629788400000,
       "pageId": "ABC3amaLg-TNYXwkU3ht4zJh-Pg",
       "numEvents": 1,
       "numMinutes": 1,
       "remoteIp": "76.90.115.123",
       "server": "clientname.io",
       "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36",
       "visitorId": "fakevisitor1",
       "parameters": {
           "parameter": "helparticle-2"
        } 
    0
    Comment actions Permalink
  • Avatar
    Angela Holly

    If desired, here's how you could filter for a specific parameter for a specific page

    {
      "response": {},
      "request": {
        "name": "ExampleAggregation",
        "pipeline": [{
            "source": {
              "pageEvents": {
                "pageId": "ABC3amaLg-TNYXwkU3ht4zJh-Pg"
              },
              "timeSeries": {
                "period": "dayRange",
                "first": "now()",
                "count": -1
              }
            }
          },
          {
            "filter": "parameters.parameter == `helparticle-1`"
          },
          {
            "limit": 100
          }
        ],

        "requestId": "ExampleAggregation"

      }

    }

     

    Example response

    {
      "startTime": 1629788400000,
      "results": [{
        "accountId": "fakeaccount1",
        "appId": -323232,
        "day": 1629788400000,
        "pageId": "ABC3amaLg-TNYXwkU3ht4zJh-Pg",
        "numEvents": 3,
        "numMinutes": 3,
        "remoteIp": "76.90.115.123",
        "server": "clientname.io",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36",
        "visitorId": "fakevisitor1",
        "parameters": {
          "parameter": "helparticle-1
          "
        }
      }]
    }
    0
    Comment actions Permalink

Please sign in to leave a comment.