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.
Some clickstream fields are currently inactive but still visible in your export. Any inactive fields are indicated below.
Flattened Clickstream User Data Fields and Definitions
User and Session Information
| Data Fields | Definitions | Type |
| session_id | Unique id given to each time that one device visits the site. Resets after 90 minutes. | integer |
| session start | The date and time the user started their session. | date/time |
| ds | The date the user started their session | date |
| ballot_id | Unique id assigned to a user after information has been submitted through the widget. | integer |
| locale | If you have a translated site, you can see what language a voter opted to use on your site (e.g. 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). | string |
| device type | The type of device used to access the site: desktop or mobile | string |
| 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. | string |
| election_center_tiles | A list of tiles that a Civic Center user clicked on. | array |
Sources
| Data Fields | Definitions | Type |
| initial_referrer | The site that the user was on before they entered your Civic Center or Recruitment Engine. In many cases, this is where the widget is embedded, but could be another site if your product does not require a widget. | string |
| utm_source | The utm-source code that was set in the link or widget when the user entered the Civic Center. | string |
| utm_medium | The utm-medium code that was set in the link or widget when the user entered the Civic Center. | string |
| utm_campaign | The utm-campaign code that was set in the link or widget when the user entered the Civic Center. | string |
| utm_content | The utm-content code that was set in the link or widget when the user entered the Civic Center. | string |
| utm_term | The utm-term code that was set in the link or widget when the user entered the Civic Center. | string |
Basic User Data from Widget
| Data Fields | Definitions | Type |
|
address form submitted |
The number of times a user entered their address. | integer |
| address | Full address that was entered into the widget | string |
| street number | Split from address; Some addresses don't split correctly, so this field may not fully encompass every user. | integer |
| street | Split from address; Some addresses don't split correctly, so this field may not fully encompass every user. | string |
| city | Split from address; Some addresses don't split correctly, so this field may not fully encompass every user. | string |
| state | Split from address; Some addresses don't split correctly, so this field may not fully encompass every user. | string |
| zipcode | Split from address; Some addresses don't split correctly, so this field may not fully encompass every user. | integer |
| first_name | First name entered into the widget. Note that the widget allows for collecting names as optional, required, or not at all. | string |
| last_name | Last name entered into the widget. Note that the widget allows for collecting names as optional, required, or not at all. | string |
| 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. | string |
| User's email address if submitted via widget. Note that the widget allows for collecting email as optional, required, or not at all. | string | |
| opt-in | True if the user checks to receive notifications, 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. | boolean |
Ballot Engine - Voter Guide ("Research your ballot")
| Data Fields | Definitions | Type |
| n_positions_ viewed | Number of positions a user views on a voter guide. | integer |
| n_candidates_ viewed | Number of candidates a user views on a voter guide. | integer |
| n_issues_ viewed | Number of issues a user views on a voter guide. | integer |
| n_measures_ viewed | Number of measures a user views on a voter guide. | integer |
Turnout Engine ("Make a plan to vote")
| Data Fields | Definitions | Type |
| 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. | boolean |
| maptv_by_mail | True if the voter is voting by mail and false if not. | boolean |
| maptv_return_ballot | True if the voter makes a plan to return their absentee ballot. | boolean |
| maptv_request_ballot | True if the voter requests an absentee ballot. | boolean |
| maptv_in_ person | True if the voter is voting in person and false if not. | boolean |
| last_clicked | Which of in person and by mail was last clicked before the end of the session. | string |
| return_dropbox | True if the user chooses "Find a dropoff location". | Boolean |
| polling_date | The polling date chosen by the user. | date |
| early_voting | True if the above date is an early voting date. | boolean |
| date_step_next | True if the user clicks "Next" after selecting a polling day. | boolean |
| polling_place_ name | Name of polling place the user selected. | string |
| location_step_ next | True if the user clicks "Next" after selecting a polling place. | boolean |
| voting_plan_ created | True if the user clicked "Finish" and got a plan summary. | boolean |
| voting_plan_ vote_at | The date and time the user selected in their voting plan, as seen on the summary on the final page of the flow. | date/time |
| voting_plan_ drop_off | True if the user makes a plan to drop off their ballot. | boolean |
| added_to_ calendar | The user added their voting plan to their calendar. (inactive) | boolean |
Registration Engine ("Voter registration")
| Data Fields | Definitions | Type |
| are you registered? | The value of the radio button selected at the beginning of the registration flow. Value will be "Check my registration" or "Register to vote", depending on the user's selection. | string |
| chose_register_online | The user selected the option to register online. | boolean |
| chose_register_by_ |
The user selected the option to register by email. | boolean |
| first_name_ registration | First name from registration check. | string |
| last_name_ registration | Last name from registration check. | string |
| date of birth | Date of birth from registration check. | date |
| voter file match |
True if user matches to voter file. |
boolean |
| voter id | Unique id from the voter file. | string |
| voterbase id | Unique id given to each user by TargetSmart. | string |
| not matched | The text of the button a user clicks after a failed registration check. | string |
| registration_ flow_complete | The user completed the final step of the registration flow. | boolean |
| email_ reminders | Email from reminders stage in the flow. | string |
| phone_ reminders | Phone from reminders stage in the flow. | string |
Vote By Mail Engine ("Request a ballot")
| Data Fields | Definitions | Type |
| downloaded | The user downloaded the ballot request. (inactive) | boolean |
| emailed | The user was emailed the ballot request form. | boolean |
| portal | The user clicked to be taken to state or county online ballot request portal. | boolean |
| printed | The user requested ballot request to be printed and mailed to them for wet signature. (inactive) | boolean |
| submitted form | The user filled out a form that we've built into our vote by mail engine. (inactive) | boolean |
| summary page | Did the user reach the summary page? | boolean |
Pledge Engine ("Pledge to vote")
| Data Fields | Definitions | Type |
| pledge_reasons | The user completed a pledge to vote, the value is the pledge reason(s) they selected. | array |
| pledged_name_entered | The name that the user entered when pledging to vote. | string |
| pledged_name_signed | The name that the user signed with when pledging to vote. | string |
File Naming Conventions
Each CSV file uses the following system for naming:
YYYYMM_exportName_DDHHmmss1_DDHHmmss2.csv
Note: The dates included in the export name indicate when the clickstream data was captured ("export window"), not the date in which the data was exported.
YYYYMM: Year and month of the beginning of the export window.
exportName: Typically includes the organization's name, i.e. "Clickstream_YourOrganizationName"
DDHHmmss1: Timestamp of the beginning of the export window, in days, hours, minutes, and seconds.
DDHHmmss2: Timestamp of the end of the export window, in days, hours, minutes, and seconds.
For example, a filename of 202408_Clickstream_Organization_A_03053348_04052844.csv would indicate that the export window started in August 2024 ("202408"), starting on August 3 at 5:33 UTC and ending on August 4 at 5:28 UTC.
Note: The export window may be longer than the typical 24 hours if your Civic Center did not receive traffic for 1 day or more.
Last updated: November 25, 2024
If you are interested in receiving Clickstream User Data in JSON format, please reach out to your Customer Success Lead.
