Visitor pulse export

This is for:

Developer

In this article, we’ll introduce you to our visitor pulse export and how you can use it to get an insight into survey responses collected through visitor pulse.

Reporting detail

This export type provides insight into Visitor pulse responses.

As with all Qubit exports, you can specify the level of reporting detail to get a much greater understanding of reportables and focus on the details you are really interested in.

For this export type, you can select:

  • A date range to include only data covering a defined period of time

  • Exclusion dates to exclude particular days or a period of time from the data

  • Dimensions, including device type and location, which allow you to decide how to break down the data

Logic

We extract the details of all the visitors that responded to Visitor pulse questions within the defined date range. We then look at the session and user events received for those visitors to extract the device, location, user Id, and email.

  • When applying the date range filter, we take the date when the question was responded to

  • The date the question was responded to is taken from meta_recordDate according to the configured timezone

  • Dimensions such as location and device information are taken from session data. Where there are duplicate events for the same visitor’s session, we take the first value in ascending alphabetical order

  • Where there are multiple responses to a single question, we output a row for each distinct answer

  • The response we return is based on the question type. For example, if the question type is text, we return the response text. If the question type is radio, we return the text associated with the selected radio button.

The survey timestamp is based on the meta_ts field associated with the survey response, that is, the epoch time in milliseconds when the event is emitted by the UV API script.

There is therefore a possibility of a timezone conflict between the survey timestamp, which is in UTC, and the date range filter, which is in the timezone configured for the property.

Note

Duplicate session events typically account for less than 1% of all session events.

Dimensions and output

Dimensions

Name Description Output

Device Type

The visitor’s device type when the Visitor pulse question was responded to

deviceType

Operating System

The visitor’s operating system when the Visitor pulse question was responded to

osName

Browser Version

The visitor’s browser and browser version number when the Visitor pulse question was responded to

browserVersion

Country

The country the visitor was in when the Visitor pulse question was responded to

country

Region

The region the visitor was in when the Visitor pulse question was responded to

region

Metro Area

The metro area the visitor was in when the Visitor pulse question was responded to

area

City

The city the visitor was in when the Visitor pulse question was responded to

city

Returning Visitor

- Whether the visitor is new or returning- TRUE for returning visitors, FALSE for new visitors

returningVisitor

Output

Additional fields not included in the dimensions table above:

Field Description

surveyTimestamp

The time and date of the survey response, based on meta_ts

surveyId

Unique identifier of the survey

questionOrder

The position of the question in the overall order of questions

questionText

The text of the question

questionType

The type of the question (for example, "checkbox")

questionAnswer

The response to the question

questionFreetext

The response to any free text fields associated with the question