Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(analytics): add table for default user props #1846

Merged
merged 1 commit into from
Jan 9, 2024
Merged

docs(analytics): add table for default user props #1846

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 20 additions & 18 deletions docs/product-and-design/analytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Analytics

The [Cal-ITP Benefits application](https://benefits.calitp.org/) uses [Amplitude](https://amplitude.com/) to collect specific user and event data properties to analyze application usage.
The Cal-ITP Benefits application, currently live at `https://benefits.calitp.org/`, uses [Amplitude](https://amplitude.com/) to collect specific user and event data properties to analyze application usage.

## Information not collected

Expand All @@ -13,36 +13,38 @@ See the [Amplitude analytics code on GitHub](https://github.com/cal-itp/benefits

## User information collected

A combination of default and application-specific custom user properties are collected for each user who visits the [Cal-ITP Benefits](https://benefits.calitp.org/) application.
A combination of default and application-specific custom user properties are collected for each user who visits the Benefits web application.

### Default Amplitude user properties collected

The following attributes are collected from the browser of every user who visits the application, provided the browser does not block the tracking library:

- Platform
- Device type
- Device family
- Country
- City
- Region
- Start version
- Version
- Carrier
- OS: Operating system name and version
- Language
- Library
User property | Description | Example value(s)
-- | -- | --
**Carrier** | The device's carrier. | `Verizon`
**Country** | Country of the event. This is pulled using GeoIP. | `United States`
**City** | City of the event. This is pulled using GeoIP. | `San Francisco`
**Device family** | Family of the device. | `Apple iPhone, Samsung Galaxy Tablet, Windows`
**Device type** | Specific type of device. | `Apple iPhone 6, Samsung Galaxy Note 4, Windows`
**Language** | Language of the device. | `English`
**Library** | Library used to send the event. | `Amplitude-iOS/3.2.1, HTTP/1.0`
**OS** | Operating system is the name of the user's mobile operating system or browser. Operating system version is the version of the users' mobile operating system or browser. | `iOS 9.1, Chrome 46`
**Platform** | Platform of the product. | `Web`
**Region** | Region (e.g. state, province, county) of the event. This is pulled using GeoIP. | `California`
**Start version** | First version of the application identified for the user. | `1.0.0`
**Version** | Current verison of the application identified for the user | `1.0.0`

Read more about each property on the [Amplitude documentation](https://help.amplitude.com/hc/en-us/articles/215562387-Appendix-Amplitude-User-Property-Definitions).

### Custom user properties collected

The following custom user attributes are collected when the user performs specific actions on the application, like selecing an eligibility type or transit agency:

| Custom user property | Description | Example value |
| User property | Description | Example value(s) |
| ---------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `eligibility_types` | Eligibility type chosen by user  | `[veteran]` |
| `eligibility_verifier` | Eligibility verifier used by user  | `VA.gov - Veteran (MST)` |
| `referrer` | URL that the event came from  | [https://benefits.calitp.org/eligibility/start](https://benefits.calitp.org/eligibility/start) |
| `referrer` | URL that the event came from  | `https://benefits.calitp.org/help/` |
| `referring_domain` | Domain that the event came from  | `benefits.calitp.org` |
| `transit_agency` | Agency chosen by the user  | `Monterey-Salinas Transit` |
| `user_agent` | User's browser agent  | `Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36` |
Expand Down Expand Up @@ -87,9 +89,9 @@ Read more on each of these events on the [Amplitude event documentation for Bene

These events track the progress of a user who has successfully verified their eligibility and is enrolling their payment card with the system.

- closed payment connection (e.g. Littlepay)
- closed payment connection
- returned enrollment
- started payment connection (e.g. Littlepay)
- started payment connection

Read more on each of these events on the [Amplitude event documentation for Benefits, filtered by Enrollment](https://data.amplitude.com/public-doc/hdhfmlby2e?categories=id%3D1702329910563%26group%3Dcategories%26type%3DString%26operator%3Dis%26values%255B0%255D%3Denrollment%26dateValue%255Btype%255D%3DSINCE).

Expand Down