JSON Clickstream User Data Dictionary

Premium customers have the option to receive their user data in JSON format. In the JSON, you'll receive a list of the clicks that users have made as they progress through your Civic Centers. From these clicks, you’ll be able to get a sense of what actions users took during their visit. 

Understanding each click event

Each click event is represented by a single JavaScript object in your JSON file. Each object has the following properties:

action

This property identifies which click event was fired in the browser. This is the most important property for understanding your clickstream data.

properties

This is a nested object that includes relevant information associated with the click event. For example, when a user fills out the widget and enters the Civic Center, the event with the action value of Address Form Submitted will include the data that the user entered, including first_name, last_name, email, phone, address, etc. Not every click event will have associated properties, in which case the properties object will be empty.

ballot_id

Created when a new address is entered into the Civic Center during the action labeled Ballot processing completed. We recommend using session_id as the primary way to identify users, but in some circumstances, this can be a secondary reference point for user identification.

event_id

Unique identifier for each individual clickstream event.

initial_referrer

Identifies the website the user was on before they entered your Civic Center. In many cases, this is where the widget is embedded. The initial_referrer property can sometimes be blocked by browsers with advanced privacy features, so we recommend using UTM codes to track your traffic across sites. However, this property can be a helpful secondary identifier.

initial_url

Identifies the first URL the user landed on when they entered your Civic Center. In most cases, this value will be “app.[yourorgname].civicengine.com”, unless you specify a data-destination within your widget.

session_id

Unique identifier for an individual session inside a Civic Center. We recommend using sessions to identify each Civic Center visitor.

 A new session is created when:

• A user enters the Civic Center from a browser that has never been used to access the site.
• A user enters the Civic Center 1) from the same browser and 2) it's been more than 90 minutes since they first entered the Civic Center.

A new session will not be triggered when:

• A user enters from the same browser on the same device within 90 minutes of their first entry into the Civic Center. This is true even if the user enters a different address.

utm_campaign, utm_content, utm_medium, utm_source, utm_term

UTM codes that were set when the user first entered the Civic Center.

Each object may have additional properties that are used for internal purposes. For more information about using your JSON clickstream data, please reach out to your Customer Success Lead.