Flattened Clickstream User Data Dictionary

Clickstream User Data is available as a flattened .csv export, and includes user information collected throughout user sessions in your Civic Center.

You can set up a daily flattened .csv export of Clickstream User Data in CivicEngine Manage. Exports can be delivered to either a Google Drive folder or an Amazon S3 Bucket.

Click here to view a sample of .csv clickstream data in Google Sheets.

Flattened Clickstream User Data Fields and Definitions:

Data Fields	Definitions
session_id	Unique id given to each time that one device visits the site. Resets after 90 minutes.
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) You may also see a different code here including your organization name if we have made any site copy alterations on your behalf (i.e. en-US-OrgName).
device type	The type of device used to access the site: 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 site that the user was on before they entered your CivicEngine instance. In many cases, this is where the widget is embedded, but could be another site if your CivicEngine product does not require a widget.
utm_source	Identify the advertiser, site, publication, etc. that is sending traffic to your property.
utm_medium	The advertising or marketing medium that is sending traffic to your property.
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. Note that the widget allows for collecting names as optional, required, or not at all.
last_name	Last name entered into the widget. Note that the widget allows for collecting names as optional, required, or not at all.
phone	User's phone number if submitted via widget. Note that the widget allows for collecting phone numbers as optional, required, or not at all.
email	User's email address if submitted via widget. Note that the widget allows for collecting 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 clicked.
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.
return_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?	Every time a voter clicks "Check my registration" or "Register to vote" is recorded. A voter could click either option as many times as they want, but the flattened CSV will 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	The user downloaded the ballot request.
emailed	The user requested ballot request form to be sent to their email.
portal	The user clicked to be taken to state or county portal.
printed	The user requested ballot request to be printed and mailed to them for wet signature.
submitted form	The user 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	True if the above date is an early voting date.
date_step_next	True 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	True if the user clicks next after selecting a polling place.
voting_plan_ created	True if the user clicked "Finish" and got a 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.
pledge_reasons	The user completed a pledge to vote, the value is the pledge reason they selected.
pledged_name_entered	The name that the user entered when pledging to vote.
pledged_name_signed	The name that the user signed with when pledging to vote.

Last updated: April 10, 2024

If you are interested in receiving Clickstream User Data in JSON format, please reach out to your Customer Success Lead.