User Data Dictionary

BallotReady provides User Data at an Individual level, which can be shared in a daily JSON export to an S3 bucket hosted by the customer, or a weekly .csv of condensed clickstream data uploaded to a Google Drive folder hosted by BallotReady. 


If you are looking for information about Aggregate User Data (Google Data Studio), you can find that here. 


Clickstream only counts users after they have entered their address in the widget and clicked "Get Started." 


Individual User Data Fields and Definitions:


session_id: Unique id given to each time that one device visits the site. Resets after 90 minutes.

tenant_id: unique id given to your BallotReady site

session start: The time at which each user starts their session

ds: The date at which each user starts their session without time.

ballot_id: Unique id given to each time someone enters the widget

locale: If you have a translated site, you can see what language a voter opted to use on your site (eg English, Spanish)

device type: The type of device used to access the site. Essentially always desktop or mobile.

operating system: Which operating system the device was running. Windows versions are distinguishable e.g. Windows 10 vs Windows 7. Other common operating systems are listed as Mac OS, iOS, Android OS, Linux.

initial_referrer: The link at which the user entered their address

utm_source: Identify the advertiser, site, publication, etc. that is sending traffic to your property, for example

utm_medium: The advertising or marketing medium, for example

utm_campaign: The individual campaign name, slogan, promo code, etc. for a product.

utm_content: Used to differentiate similar content, or links within the same ad. For example, if you have two call-to-action links within the same email message, you can use utm_content and set different values for each so you can tell which version is more effective.

utm_term: Identify paid search keywords. If you're manually tagging paid keyword campaigns, you should also use utm_term to specify the keyword.

address form submitted: The number of times a user entered their address

address: Address that was entered into the widget

street number: Split from address; Some addresses don't split correctly, so this field may not fully encompass every user.

street: Split from address; Some addresses don't split correctly, so this field may not fully encompass every user.

city: Split from address; Some addresses don't split correctly, so this field may not fully encompass every user.

state: Split from address; Some addresses don't split correctly, so this field may not fully encompass every user.

zipcode: Split from address; Some addresses don't split correctly, so this field may not fully encompass every user.

first_name: First name entered into the widget

last_name: Last name entered into the widget

phone: User's phone number if submitted via widget. Note that the widget allows for including phone numbers as optional, required, or not at all.

email: User's email address if submitted via widget. Note that the widget allows for including email as optional, required, or not at all.

opt-in: True if the user checks to receive notificaitons, false if not checked, blank if opt-in is not part of the widget. Note that the widget allows for including opt-in as optional, required, or not at all.

election_center_tiles: Tiles that an Election Center user click.
n_positions_viewed: Number of positions a user views on a voter guide.
n_candidates_viewed: Number of candidates a user views on a voter guide.
n_issues_viewed: Number of issues a user views on a voter guide.
n_measures_viewed: Number of measures a user views on a voter guide.

intro step: get started clicked: True if the user selects get started. A useful indicator for if a user started the make a plan flow.

maptv_by_mail: True if the voter is voting by mail and false if not.
maptv_return_ballot: True if the voter makes a plan to return their absentee ballot.
maptv_request_ballot: True if the voter requests an absentee ballot.

maptv_in_person: True if the voter is voting in person and false if not.

last_clicked: Which of in person and by mail was last clicked before the end of the session

maptv_dropbox: TRUE if the user chooses "Find a dropoff location" in the "Return Your Ballot" flow. The dropoff flow involves choosing a location (which is a page that is repeated in the in-person flow) and then the "maptv: voting plan created" field, as in the in-person flow, so you can use this new field to filter out when the voter made their plan to vote in person or through a dropbox

are you registered?: We record every time a voter clicks yes or no on that step. A voter could click either option as many times as they want, and we record each one. With our flattened data structure (csv), we just show the value returned on the user's last click.
chose_register_online: The user selected to register online.
chose_register_by_email: The user selected to register by email.

first_name_registration: First name from registration check.

last_name_registration: Last name from registration check.

date of birth: Date of birth from registration check

voter file match: True if user matches to voter file

voter id: unique id from the voter file

voterbase id: unique id given to each user by TargetSmart

not matched: The text of the button each user clicks after a failed registration check
registration_flow_complete: The user completed the registration flow.

email_reminders: Email from reminders stage in the flow.

phone_reminders: Phone from reminders stage in the flow.

downloaded: Voter downloaded the ballot request.

emailed: Voter requested ballot request form to be sent to their email

portal: Voter clicked to be taken to state or county portal.

printed: Voter requested ballot request to be printed and mailed to them for wet signature.

submitted form: Voter filled out a form that we've built into our vote by mail engine

summary page: Did the user reach the summary page

polling_date: the final polling date chosen by the user on "Step 2

early_voting: Boolean that is true, if the above date is an early voting date

date_step_next: If the user clicks next after selecting a polling day

polling_place_name: Name of polling place if one is selected in "Step 3

location_step_next: If the user clicks next after selecting a polling place

voting_plan_created: Boolean that is true if the user clicks "Finish" and gets the plan summary.

voting_plan_vote_at: The final page also contains a field that has the date and time the user selected, so I include that here. This should match the polling_date field but I kept both in case the user drops out before this stage. 

voting_plan_drop_off: True if the user makes a plan to drop their ballot off.
added_to_calendar: The user added their voting plan to their calendar. 


Last updated: October 5, 2021

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.