Mixpanel Events and Properties for the NDE UI
Introduction
Libraries can use Mixpanel to receive anonymous real-time data about user behavior in Primo discovery. This allows libraries to make data-driven decisions and improve user engagement and retention. This page details the out-of-the-box events used to track users' interactions with the NDE UI, and the properties associated with each event.
Mixpanel Properties
Properties track the specific details of an event. For example, The event may be that someone performed a search, and its properties may include the search query, scope of the search, etc. The following types categorize the supported properties:
-
General Technical Properties (global filters)—These default properties specify hardware details, OS, browser type, referrals, etc.
-
General Primo Properties (global filters)—These properties include general Primo VE information relevant to all events, such as the Primo View, On Campus, User Type, etc.
-
Unique Properties (inline filter)—These properties are specific to a particular event and add related information, such as search and facet usage details.
General Technical Properties
General technical properties are listed in the UI under the Mixpanel Properties tab. They include hardware, country, OS, Browser, Referrals and more. Those properties are sent for all events and can be used in the reports to filter or break the data.
The following table lists all the supported General Technical properties:
Properties | Example of Values | Comments |
---|---|---|
Browser |
Chrome, Explorer, etc. |
|
Browser version |
36.31…etc. |
|
Country |
Spain, Israel, USA, etc. |
This property is calculated on the Primo server based on the user’s IP and then sent to Mixpanel. |
Operating System |
Android, IOS |
|
Platform |
Mobile, Desktop |
|
Referrer |
https://www.google.com/search?q=albert+ |
The full URL used to access the content in Primo VE. |
Referring Domain |
google.com |
|
Screen Height |
1080 |
Measured in pixels. |
Screen Width |
2280 |
Measured in pixels. |
General Primo Properties
General Primo properties are listed in the UI under the Mixpanel Properties or Your Properties tabs. These tabs contain Primo information relevant to all events and users, such as the Primo View, On Campus, User Type, etc. These properties are sent for all events and can be used in the reports to filter or break the data.
The following table lists all the supported General Primo properties:
Properties | Example of Values | Comments |
---|---|---|
Device ID |
Fcc3b5134a9a2649bb6d18c08dd1dec |
Generated random session ID for |
Distinct ID |
8e0b53dc5266e7c419d90580d7243366… |
Hash encryption of Alma User ID used for signed-in users. For guest users, this property includes the Device ID value. |
User Type |
Guest, Logged In |
|
User Group |
Guest, Faculty, Staff |
|
Primo View |
EXLDEV1_INST:Alma |
|
Institution Code |
EXLDEV1_INST |
|
Institution Name |
Alma University |
|
On Campus |
Yes, No |
|
Page Name |
Search page, Journal Search, Full Display, Browse Page, Favorites Page etc. |
The page name where the event |
Unique Properties for Events
Unique properties are listed in the UI under the Your Properties tab and contain specific information related to a particular event These properties are sent per event and can be used to filter or break the data.The unique properties are listed per event in this section.
Additional Links
The Additional Links event collects all the links that do not link to electronic full-text or digital versions. Users can select these links from the following places:
-
Get it
-
How to get it
-
View it\online
-
Links section
The following types of links are tracked as part of this event:
-
GES (General Electronic Services)
-
Source record
-
Any other link from the PNX that is not linked to the resource (for example, addlink, backlink, etc.).
The following table lists all the supported properties for the Additional Links event:
Properties | Example of Values | Comments |
---|---|---|
Additional Link Type |
GES, Source Record, addlink, backlink |
From the PNX we might get more link types, in this case we will take it as is. GES link in the links section is tracked as addlink and not GES. |
Displayed Link Name |
Search in google…etc |
In most cases the display name comes from the link. Exceptions : • Source Record link - the Displayed name will be Display Source Record. • GES link – the Displayed name is the GES service name • Links from the PNX – there are cases the code is used and not the label. |
Page Area |
view it, how to get it, get it, links |
the section in the full display. |
Record Title |
Hamlet |
|
Record ID |
alma99273228800191 |
|
Resource Type |
book, article |
|
Banner Actions
The following table lists all the supported properties for the Banner Actions event:
Properties | Example of Values | Comments |
---|---|---|
Banner Action Type |
Click On, Close |
|
Banner Type |
Vertical, Horizontal |
|
Banner Name |
State Library University .... |
the name of the banner using the label 'nui.resourceRecommendation.banner. <banner_name>.name')- the first title in the banner. |
Banner Title |
Welcome to the new learning experience... |
the Title of the banner The main title in the banner |
BX Recommendations
The following table lists all the supported properties for the bX Recommendations event:
Properties | Example of Values | Comments |
---|---|---|
BX Recommendations Action |
Open , Collapse, Expand, More Suggestions |
|
Record Title |
Hamlet |
Send this property only with the Open action |
Change Language
The following table lists all the supported properties for the Change Language event:
Properties | Example of Values | Comments |
---|---|---|
Language |
English, Hebrew |
Citation Linker
Available with the August 2025 release.
The following table lists all the supported properties for the Citation Linker Actions event:
Properties | Example of Values | Comments |
---|---|---|
Citation Trail Actions |
Open, Submit |
|
Citation Type |
Book, Journal, Article |
|
Article Title |
Ocean |
Send only when the user selects the Article citation type. |
Book Title |
Hamlet |
Send only when the user selects the Book citation type. |
Journal Title |
Fashion |
Send only when the user selects the Journal citation type. |
Citation Trail
The following table lists all the supported properties for the Citation Trail Actions event:
Properties | Example of Values | Comments |
---|---|---|
Citation Trail Actions |
Cited By, Cited In , Next Items, Previous Items , Back To Results |
|
Record View |
Brief Record, Full Record |
|
Resource Type |
books, journals, articles |
Send this property only with Cited By and Cited In. |
Record ID |
alma99273228800191 |
Send this property only with Cited By and Cited In. |
Record Title |
hamlet |
Send this property only with Cited By and Cited In. |
Collection Discovery Actions
The following table lists all the supported properties for the Collection Discovery Actions event:
Properties | Example of Values | Comments |
---|---|---|
Collection Discovery Action Type (continued on next row) |
1. Open Resource 2. Open Info 3. Add To Favorites 4. Remove From Favorites 5. Add Facet 6. Remove Facet 7. Remove All Facets 8. Sort Collection 9. Collection Search 10. List View 11. Gallery View 12. Collection Path 13. Set Persistent Facet 14. Collection Pagination |
1. Open Resource - opening any of the resources listing in the collection page or collections from search results\full display record "more from the same collection" feature 2. Info - clicking on the I icon 3. Add To Favorites - when user adding any item to favorite from the collection page 4. Remove From Favorites - when user removing any item to favorite from the collection page 5. Add Facet - when user adding any of the available facets ( as described above) 6. Remove Facet- when user removes any of the available facets ( as described above) 7. Remove All Facets- when user removes all any of the available facets ( as described above) 8. Set Persistent Facet - when user activates the toggle of remember all filters 9. List View - when user selects the list view |
Collection Discovery Action Type (continued from previous row) |
15. Remove All Facets 16. Sort Collection 17. Collection Search 18. List View 19. Gallery View 20. Collection Path 21. Set Persistent Facet 22. Collection Pagination 23. Link to Saved Records 24. Remove Saved Records Popup |
10. Gallery View - when user selects the gallery View 11. Collection Search - when user invokes a search in the search page 12. Collection Pagination - when user click on any of the pages available to him 13. Collection Path - when user clicks on the collection path 14. Sort Collection - when user sorts the item in a collection 15. Link to Saved Records - when user clicks the link to saved records that appears after adding a record 16. Remove Saved Records Popup - when a user clicks on one of the buttons of the popup |
Sort Collection By |
1. Relevance 2. Title 3. Author 4. Date Newest 5. Date Oldest |
|
Collection Search Term |
History |
|
More From The Same Collection |
Yes , No |
send Yes - if the user clicked the collection from this feature send No other wise |
Page Number |
1,2,3… |
|
Collection Name |
hamlet, History ... |
|
Resource Type |
book, journal, collection |
Sending this property only with the following actions: Open Resource, Open Info, Add To Favorites, Remove From Favorites |
Record ID |
alma99273228800191 |
Sending this property only with the following actions: Open Resource, Open Info, Add To Favorites, Remove From Favorites |
Record Title |
hamlet, History ... |
Sending this property only with the following actions: Open Resource, Open Info, Add To Favorites, Remove From Favorites |
Facets Count |
1,2,3,4 .... |
Sending this property only with the Add Facet, Remove Facet |
Facet Method |
Include, Exclude, Mix |
Sending this property only with the Add Facet, Remove Facet |
Facet Location |
Top Active Filters, Filter Side Menu |
Sending this property only with the Add Facet, Remove Facet, Remove All Facets |
Facet Type |
Availability, Resource Type, Subject, Creation Date, Library Location…etc |
Sending this property only with the Add Facet, Remove Facet |
Facet Type Name |
Availability, Resource Type, Subject, Creation Date, Library Location |
Sending this property only with the Add Facet, Remove Facet |
Facet Value |
Available Online, Peer reviewed, Held by library |
Sending this property only with the Add Facet, Remove Facet |
Facet Value Name |
Available Online, Peer reviewed, Held by library |
Sending this property only with the Add Facet, Remove Facet |
Remove Saved Records Popup Action |
Remove , Cancel |
|
Create Request
The following table lists all the supported properties for the Create Request event:
Properties | Example of Values | Comments |
---|---|---|
Request Type |
AlmaRequestOther, AlmaDigitizationOther, |
Sending the code. |
Request Type Name |
Purchase request, Resource Sharing, and so forth. |
Sending the UI label. |
Request Action Type |
Open, Sent and Approved, Sent and Denied , Sent For checking ISBN |
|
Request Material Type |
electronic , physical, digital… |
any material type the user selected > only after the submit of the request |
Level Type |
Blank Form ,Item Level, Title Level |
blank form - is for any blank request The Level Type appears on send and open Request Action |
Resource Type |
book, article |
only after the submit of the request Won't appear in the Blank request |
Record Title |
Hamlet.. |
the name of the title Won’t appear in the Blank request |
Record ID |
Alma99273228800191… |
ID of the title Won't appear in the Blank request |
ISBN Popup |
Cancel, View Record |
|
Consortium Institution Code |
01WRLC_GUNIV |
Only in Resource sharing |
Consortium Institution Name |
Harvard, Yale |
Only in Resource sharing |
Create Request By Rapido
-
In Mixpanel, you can use the General Filter Product Name to differentiate this event from Primo VE events.
-
This event is not currently supported.
The following table lists all the supported properties for the Create Request By Rapido event:
Properties | Example of Values | Comments |
---|---|---|
Request Action Type |
1. Open 2. Sent and Approved 3. Sent and Denied |
|
Refined Request |
Yes, No |
|
Rapido Request Type |
Physical, Digital, Journals, eBook |
|
Record Title |
Hamlet |
|
Resource Type |
book, article |
Send the values as a list array for multiple and single values as well |
Display Full Record
The following table lists all the supported properties for the Display Full Record event:
This event is planned for the July 2025 release.
Properties | Example of Values | Comments |
---|---|---|
Clicked On |
Brief Record , Online Availability, Physical Availability, Your Selected Record (FRBR) Full Display ( in the future when we will have the more from the same collection" feature) |
1. Brief Record: is the title click 2. The availability statement for online - only when no direct link is configured 3. Your Selected Record - when the user clicks the first record in the FRBR version list - only when the feature is configured 4. Full Display - when we have a record link in the full display of a record. in the future also a collection or an item under the " more from the same collection" feature |
Resource Type |
book, article, journal etc. |
Sending the code name Resource Type: "journal" no resource type for records from my account > the info comes from an API from Alma send the values as list array for multiple and single value as well it will be separated like this: [“books”, “journals”, “video”] [“books”] |
Record Title |
Hamlet |
The title of the record as displayed in the PNX. |
Record ID |
alma99273228800191 |
No support for records ID from my account. |
Expand Results
The following table lists all the supported properties for the Expand Results event:
Properties | Example of Values | Comments |
---|---|---|
Refine Action Type |
Activate, Deactivate |
Clicking the radio button activate and deactivate the feature |
Refine Type |
Search In Full Text, Expand Results |
Sending the code |
Refine Type Name |
Expand My Results Text, Search In Full Text |
Sending the value as is |
Search Term |
Art, History , No Query etc’ |
|
Facets Usage
The following table lists all the supported properties for the Facets Usage event:
Properties | Example of Values | Comments |
---|---|---|
Facet Action Type |
Add, Remove , Reset all |
|
Facets count |
1,2,3,4 .... |
Number of facets selected (single or multi facet) |
Facet Method |
Include, Exclude, Mix |
the mix refers to a situation when user selecting a mix of include and exclude at the same time |
Facet Type Name |
Availability, Resource Type, Subject, Creation Date, Audience etc. |
The values will be the label which is displayed in the UI. send the values as list array for multiple and single value as well |
Facet Type |
tlevel, rtype, topic, creationdate, ld10 |
The values is the facet type code. send the values as list array for multiple and single value as well |
Facet Value Name |
Available Online, Peer reviewed, Held by Library |
The values will be the label which is displayed in the UI. send the values as list array for multiple and single value as well |
Facet Value |
available_p, peer_reviewed, open_access, eng |
The values will come from the code. institutions can create their facet value so we should be able to track the code name as well. send the values as list array for multiple and single value as well |
Facet Location |
Quick Filters, Top Active Filters, Filter Side Menu |
Quick Filters - when the action is being performed on any of the Quick Filters ( even when the quick filters are being active we consider them Quick Filters Top Active Filters - when the remove action is being performed on any of the Top Filters which are not set as Quick Filters Filter Side Menu- when the action is being performed on any of the Filter Side Menu |
Fines & Fees Actions
The following table lists all the supported properties for the Fines & Fees Actions event:
Properties | Example of Values | Comments |
---|---|---|
Fines & Fees Action Type |
Filter Fine Status, Pay Fine, Institution Selection, Expand All, Collapse All, Expand Single Fine , Collapse Single Fine , Sort Fines |
1. Filter Fine Status - when user selects a value from the status Filter dropdown 2. Pay Fine - when user clicks the pay fine button 3. Institution Selection - user selects an institution from the institution dropdown 4. Expand All - user clicks expand all button 5. Collapse All - user clicks expand all button after expanding all 6. Expand Single Fine - user clicks expand button 7. Collapse Single Fine - user clicks expand button after expanding the record box 8. Sort Fines - when user User is using the Sort By options |
Fine Status |
Active Fines, In Dispute Fines, Closed Fines , All |
send only with Filter Fine Status |
Fines Sort By |
Fine Date - Newest, Fine Date - Oldest, Title |
send only with Sort Fines |
Fines & Fees Institution Name |
Harvard, Toronto University |
1. send only with Institution Selection 2. the name of the university > only after the change 3. if the user opens the drop-down and closes it with no selection we don't send any event |
Amount |
10, 22, 45 |
the amount of the fine\fee the user needs to pay |
FRBR Links
This event is not sent with CDI links.
The following table lists all the supported properties for the FRBR Links event:
Properties | Example of Values | Comments |
---|---|---|
Versions Count |
1,2,3,4 |
The number of versions in the FRBR group |
Record Title |
Hamlet |
|
Resource Type |
book, article |
|
Record ID |
alma99273228800191 |
|
Full Display Record Actions
This event is not currently supported.
The following table lists all the supported properties for the Full Display Record Actions event:
Properties | Example of Values | Comments |
---|---|---|
Full Display Action Type |
Expand, Collapse |
|
Section |
Links, Details, View Online |
Send the code value |
Section Name |
Links, Details, View Online |
Send the label as in the UI |
Record Title |
Hamlet |
|
Resource Type |
book, article |
Send the values as list array for multiple and single value as well |
Record ID |
alma99273228800191 |
|
Home Page Navigation
The following table lists all the supported properties for the Home Page Navigation event:
Properties | Example of Values | Comments |
---|---|---|
HP Navigation Type |
1. Links Button 2. Go To Button 3. Personal Links |
|
HP Links Buttons Name |
Opening Hours, FAQ, Ask A Librarian |
Send the label as in the UI |
Go To Button Name |
Go To My Library Card |
Send the label as in the UI |
Lateral Links
The following table lists all the supported properties for the Lateral Links event:
Properties | Example of Values | Comments |
---|---|---|
Field |
Subject, creator, lds10 |
The values is the field code. |
Field Name |
Subject, Creator, Audience |
The values will be the label which is displayed in the UI |
Field Value |
Medicine – History, Shakespeare, William |
|
Record Title |
Hamlet |
|
Record ID |
alma99273228800191 |
|
Resource Type |
book, article |
|
Loans Page Actions
The following table lists all the supported properties for the Loans Page Actions event:
Properties | Example of Values | Comments |
---|---|---|
Loans Page Action Type |
1. Filter Loan Status 2. Sort Loans 3. Expand All 4. Collapse All 5. Expand Single Record 6. Collapse Single Record 7. Institution Selection |
|
Loan Type |
1. Active Loans 2. Previous and Historic Loans |
Send this property only with - Filter Loan Status |
Loans Sort By |
1. Due Date – Newest 2. Due Date – Oldest 3. Title 4. Status 5. Return Date – Newest 6. Return Date - Oldest |
|
Loans Page Institution Name |
Harvard, Toronto University |
|
Main Menu Links
The following table lists all the supported properties for the Main Menu Links Actions event:
Properties | Example of Values | Comments |
---|---|---|
Link Name |
1. Library Search 2. Journal Search 3. Collection Discovery 4. Browse 5. Tags 6. Blank 7. Purchase Request 8. Blank ill Request |
Sending the code value |
Online Resource Link
Online Resource Link event collects all the actions the user invokes to get the electronic full text or digital version.
The following links can be selected from various places:
-
Brief record
-
View it
-
Links section
-
Links in the Digital Section (Alma D)
The following types of links are tracked as part of this event:
-
Quicklinks HTML and Quicklinks PDF
-
Open URL
-
Unpaywall PDF
-
Link To Resource - Electronic (link to full text from the View It section)
-
Link To Resource - Digital (link to digital version from the View It section)
-
Link To Resource (link to full text from Links section)
-
Check Consortium Institutions (View It for other institutions)
-
Open URL Additional
-
Link To Resource Additional
The following table lists all the supported properties for the Online Resource Link event:
Properties | Example of Values | Comments |
---|---|---|
Online Resource Link Type |
Quicklinks HTML, Quicklinks PDF, Open URL, Unpaywall PDF, Link To Resource - Digital Link To Resource - Electronic Check Consortium Institutions Open URL Additional Link To Resource Additional Link To Resource |
Tracks also the online availability statement if direct link is enabled. |
Displayed Link Name |
Read Online, Available Online |
In most cases the display name comes from the link. Exceptions : Quicklinks HTML = Read Online Quicklinks PDF= Get PDF Unpaywall PDF= Get PDF Available Online = Available Online |
Record Title |
Hamlet |
|
Record ID |
alma99273228800191 |
|
Resource Type |
book, article |
|
Pagination
The following table lists all the supported properties for the Pagination event:
Properties | Example of Values | Comments |
---|---|---|
Pagination Type |
Page, Record |
|
Search Term |
Hamlet |
For Page type |
Page Number |
1,2,3,4 |
For Page type |
Record Title |
Hamlet |
For Record type |
Record ID |
alma99273228800191 |
For Record type |
Resource Type |
book |
For Record type Send the values as list array for multiple and single value as well |
Pagination Click |
Next, Previous |
|
Person Page
Available with the August 2025 release.
The following table lists all the supported properties for the Person Page Actions event:
Properties | Example of Values | Comments |
---|---|---|
Person Page Referrers |
Autocomplete, Infor Card |
|
Person Page Actions |
|
|
Record Title |
Hamlet |
|
Person Name |
Albert Einstein |
|
Row |
personEntity.titlesBy personEntity,titlesWrittenAbout personEntity.relatedPeople |
Send the code value. |
Row Name |
Titles in the Library By Einstein Titles in the Library Written About Einstein People Associated With Einstein |
Send the UI value. |
Physical Location Actions
This event is planned for the August 2025 release.
The following table lists all the supported properties for the Physical Location Actions event:
Properties | Example of Values | Comments |
---|---|---|
Physical Location Action Type |
1. Open Location 2. Filter By Volume 3. Filter By Year 4. Filter By Description 5. Expand All Locations 6. Collapse All Locations 7. Locate Item 8. Expand Holding 9. Collapse Holding 10. Expand All Items 11. Collapse All Items |
1. Open Location : when the user clicks on a location row 2. Filter By Volume - when the user clicks on one of the values in the volume filter 3. Filter By Year - when the user clicks on one of the values in the in the yea filter 4. Filter By Description - when the user clicks on one of the values in the description filter 5. Expand All Locations - when the user clicks on the expand button to expand the list 6. Collapse All Locations - when the user clicks on the expand button to Collapse the list 7. Locate Item- when the user clicks on the Locate button 8. Expand Holding - when the user clicks on the holding arrow icon to expand 9. Collapse Holding - when the user clicks on the holding arrow icon to Collapse 10. Expand All Items- when the user clicks on the expand button to expand the records list 11. Collapse All Items- when the user clicks on the expand button to collapse the records list |
Location |
Main Library |
1. Sending the code name 2. Send only when the user clicks on a location |
Location Name |
Main Library |
1. Sending the label as displayed on the UI 2. Send only when the user clicks on a location |
Record Title |
Hamlet |
|
Resource Type |
book, article |
Send the values as list array for multiple and single value as well |
Record ID |
alma99273228800191 |
|
Places
Available with the May 2025 release.
The following table lists all the supported properties for the Places event:
Properties | Example of Values | Comments |
---|---|---|
Places Actions |
Displayed, Collapse, Expand |
|
Places Count |
1, 2, 3 |
|
Record Title |
hamlet |
|
Resource Type |
book, article |
|
Record ID |
alma99273228800191 |
|
Rapido Links
In Mixpanel, you can use the General Filter Product Name to differentiate this event from Primo VE events.
The following table lists all the supported properties for the Rapido Links event:
Properties | Example of Values | Comments |
---|---|---|
Link Name |
Expand Search |
The name of the link as displayed to the user |
Search Term |
water, ocean, Building |
|
Advanced Query String |
Any field contains modern art OR Any field contains water |
Send only when the link appears after an Advanced search |
Rapido Self Registration
In Mixpanel, you can use the General Filter Product Name to differentiate this event from Primo VE events.
The following table lists all the supported properties for the Rapido Self Registration event:
Properties | Example of Values | Comments |
---|---|---|
Self Registration Action |
Open Form, Register |
Open Form - when the user clicks on the "not a member register here " link Register - user clicks on the Register button |
Registration Type |
Individual, Organization |
based on the user selection in the form - individual or organization |
Record Actions
The following table lists all the supported properties for the Record Actions event:
Properties | Example of Values | Comments |
---|---|---|
Records count |
1,2,3,4 |
When we get a number above 1, it indicates a bulk action |
Record View |
Brief Record, Full Record |
The area the user performed the action |
Record Action Type |
1. Export To Excel 2. QR 3. Export RIS 4. Export BibTeX 5. EasyBib 6. Reading List 7. Mendeley 8. EndNote 9. RefWorks 10. Copy Citation 11. Print 12. Permalink 13. Email 14. Add To Favorites 15. Remove From Favorites 16. WhatsApp 17. Facebook 18. X 19. LinkedIn 20. “customized property” |
For a “customized property” We will send the code value |
Resource Type |
books, journals, articles, video |
|
Record ID |
Alma99273228800191, Mix |
Mix - in case of bulk action |
Record Title |
Hamlet, Mix |
Mix - in case of bulk action |
Excel File Type |
Xlsx, CSV |
|
RIS Type |
UTF-8 |
|
BibTex type |
UTF-8 |
|
Reading List Type |
List, Collection |
|
Citation Type |
Harvard, MLA ( 7th edition) |
|
Remove Saved Records Popup Action |
Remove , Cancel |
|
Link to Saved Records |
Single Record Link, Bulk Records Link |
|
Records Selection
This event is not currently supported.
The following table lists all the supported properties for the Record Selection event:
Properties | Example of Values | Comments |
---|---|---|
Selection Control |
Select, Unselect |
|
Selection Type |
Single Record, Displayed Results |
1. Single Record - when the user selects record by record 2. Displayed Results - when the user selects all visible records at once by checking the top checkbox |
Selection Count |
1,2,3,4... |
|
Renew Loans
The following table lists all the supported properties for the Renew Loans event:
Properties | Example of Values | Comments | |
---|---|---|---|
Renew Type |
1. Single 2. All 3. Selected |
1. Selected - after a user selects specific records > Also if a user selects only one record we will considered it as a Selected and not Single but still we will show in the record title only one title and not Mix
2. All - when a user clicks the renew all button 3. Single - when user click the renew button on a single record |
|
Renew Count |
1,2,3,4... |
the amount of records |
|
Renewal Status |
1. Approved 2. Pending 3. Failed 4. Partially Approved |
|
|
Record Title |
Hamlet , Mix, etc.’… |
1. Send only in a single renew 2. Renew all or “selected” from 2 above > send the Mix value |
Record Title |
Record ID |
Alma99273228800191, Mix |
1. Send only in a single renew 2. Renew all or “selected” from 2 above > send the Mix value |
Record ID |
Consortium Institution Code |
01WRLC_GUNIV |
1. Only in Resource sharing 2. The value of the institution code 3. The action is taking place in User Loans page > after choosing an institution |
Consortium Institution Code |
Consortium Institution Name |
Harvard, Yale |
1. Only in Resource sharing 2. the translation of the institution code |
Consortium Institution Name |
Requests Page Actions
The following table lists all the supported properties for the Requests Page Actions event:
Properties | Example of Values | Comments |
---|---|---|
Requests Page Action Type |
1. Filter Request Status 2. Filter Request Type 3. Expand All 4. Collapse All 5. Expand Single Record 6. Collapse Single Record 7. Institution Selection 8. View File 9. Download Digital Request 10. Sort Requests 11. Click Cancel Request Popup |
|
Request Type |
1. nui.librarycard.request.filter_ 2. request.bookings 3. request.cdls. 4. request.photocopies. 5. request.ill. 6. request.acq 7. request.holds 8. call slip?? |
1. Send only with Filter Request Type 2. Send the code value 3. Send the values as a list array |
Request Status |
Active Requests, Historic Requests |
Send only with Filter Request Status |
Request Type Name |
1. All 2. Booking 3. Digital Loan 4. Digitization 5. ILL 6. Purchase 7. Request 8. The name of the following value (call slip??===) |
1. Send only with Filter Request Type 2. Send the label in the UI 3. Send the values as a list array |
Requests Sort By |
1. Status 2. Title 3. Request Date - Newest |
1. Send only with Sort Requests |
Cancel Request Popup Action |
1. backToRequest 2. Confirm 3. cancelRequest |
1. Send only with Click Cancel Request Popup 2. Send the code as is |
Cancel Request Popup Action Name |
1. Cancel Request - Confirmed 2. Cancel Request - Rejected 3. Back To Requests |
1. send only with Click Cancel Request Popup 2. sending the labels as in the UI |
Requests Page Institution Name |
Harvard, Toronto University |
1. Send only with Institution Selection 2. The name of the university > only after the change 3. If the user opens the drop- down and closes it with no selection we don't send any event |
Resource Sharing Timeline |
Requested, In Process, Shipped, Received |
1. Send this property only with cancel request. 2. when the user clicks cancel, we send the position of the timeline |
Research Assistant Actions
The user used Research Assistant.
This event is planned for the June 2025 release.
The following table lists all the supported properties for the Research Assistant Actions event:
Properties | Example of Values | Comments |
---|---|---|
RA Search Actions |
Search , Reset Search |
|
RA Answer View Actions |
|
|
RA Source View Actions |
|
|
RA Access Via |
Main Menu, Widget, Deep Link |
|
RA Links |
Click AI Disclaimer, Click Help |
|
RA Search Term |
Why is the sky blue? |
Send the property value as is with the following:
|
Record ID |
alma99273228800191 |
Send this property only with the following:
|
Related Research Question Title |
What causes the scattering of light in the atmosphere? |
Related Research Question Title Send this property only with the following: Click Related Research Question |
Resource Recommender Actions
Available with the June release.
The following table lists all the supported properties for the Resource Recommender Actions event:
Properties | Example of Values | Comments |
---|---|---|
Resource Recommender Actions |
Displayed, Open, Scroll |
|
Resource Recommender Count |
1, 2, 3, 4 |
the amount of displayed resource recommend boxes Send this property only with the following: 1.Displayed |
Clicked Recommender Position |
1, 2, 3, 4 |
The position of the clicked box within the ordered list of recommended resource boxes. Send this property only with : 1. Open |
Resource Recommender Type |
Database, Library_Guide, and Website |
the code name Send this property only with the following: 1. Displayed 2. Open |
Resource Recommender Type Name |
Suggested Librarian, Library Information |
the label from the UI Send this property only with the following: 1. Displayed 2. Open |
Search Term |
art, hamlet |
Send this property only with the following: 1. Displayed 2. Open |
Saved Records Actions
This event is planned for the August 2025 release.
The following table lists all the supported properties for the Saved Records Actions event:
Properties | Example of Values | Comments |
---|---|---|
Saved Records Action Type |
Search Saved Record, Filter Label , Sort Records, Add Label |
|
Saved Records Sort By |
Date Added, Author, Title |
Send only with Sort Records |
Saved Search Term |
Art ... etc Mix |
1. In case of bulk action send the value: Mix 2. The name of the search for basic and filter bar search or |
Saved Search Advanced Query String |
any contains Should trees have standing AND creator contains stone, Mix |
1. in case of bulk action send the value: Mix 2. Send only with Advanced search |
Saved Searches Actions
The following table lists all the supported properties for the Saved Searches Actions event:
Properties | Example of Values | Comments |
---|---|---|
Saved Records Action Type |
Search Saved Record, Filter Label , Sort Records, Add Label |
|
Saved Records Sort By |
Date Added, Author, Title |
Send only with Sort Records |
Saved Search Term |
Art ... etc Mix |
1. In case of bulk action send the value: Mix 2. The name of the search for basic and filter bar search or |
Saved Search Advanced Query String |
any contains Should trees have standing AND creator contains stone, Mix |
1. in case of bulk action send the value: Mix 2. Send only with Advanced search |
Search
The search event includes multiple types, which can be filtered or broken down in Mixpanel using the Search Type property. In the following design, we will address each type individually to better highlight their unique properties and differences. The following Search types are supported:
-
Basic
-
Did You Mean – Indicates that the user selected the “Did You Mean” link after performing a search.
-
Advanced
-
Filter Bar
Search (Basic or Did You Mean)
The user performed either a Basic search or a Did You Mean search.
The following table lists all the supported properties for the Search event:
Properties | Example of Values | Comments |
---|---|---|
Search Type |
Basic |
|
Search Term |
Art, history.. etc. |
For advanced search, this property is sent only when one line of search is sent. Otherwise, the ‘‘Advanced Query String’ property is sent. |
Results Number |
0,1,2,7589…etc. |
|
Scope Type |
local ,blended, deep_search, |
|
Tab Name |
My_institution, science_library, music, etc. |
The values is the scope code |
Tab Label |
My Institution, Science Library, Music, etc. |
The values will be the scope label as in the UI |
Operator Type |
Contains, Contains Exact Phrase, Starts With, Equals Exact Phrase |
|
Facet used |
Persistent, None, Regular |
This property indicates if a facet is included in the search. |
Index Type |
any, title, creator, subject, course_instructor, etc. |
The values is the index code. |
Index Type Name |
Any field, Title, Creator, Subject, Course Instructor, etc. |
The values will be the label as displayed in the UI |
Scope Label |
Articles And More, All Locations, etc. |
The Label as in the UI |
Scope Name |
Articles And More, All Locations, etc. |
the code value |
Search (Advanced)
The user performed an Advanced search.
The following table lists all the supported properties for the Search event:
Properties | Example of Values | Comments |
---|---|---|
Search Type |
Advanced |
|
Results Number |
0,1,2,7589…etc. |
|
Scope Type |
local ,blended, deep_search, |
|
Tab Name |
My_institution, science_library, music, etc. |
The value is the scope code. |
Tab Label |
My Institution, Science Library, Music, etc. |
The value is the scope label in the UI. |
Resource Type |
books, journals, articles, video, etc. |
For Advanced and Filter Bar |
Advanced Query String |
Any field contains modern art OR Any field contains water AND User tags contains exact phrase whale |
This is the search term of the advanced search. |
Scope Name |
Articles And More, All Locations, etc. |
Send the code value |
Scope Label |
Articles And More, All Locations, etc. |
Send the Label as in the UI |
Search Date |
11.23.2021-01.12.2022 |
Send full date value from> to |
Advanced Search Language |
English, French ' |
1. Sending the language code. 2. Since its a multiple-option selection in the advanced search > 3. send the values as list array for multiple and single value as well it will be separated like this: [“Hebrew”, “English”, “German”] [“English”] |
Advanced Search Language Name |
English, French ' |
1. Sending the language value as displayed in the UI 2. since its a multiple option selection in the advanced search > 3. send the values as list array for multiple and single value as well it will be separated like this: [“Hebrew”, “English”, “German”] [“English”] |
Search (Database)
The user performed a search using Database Search.
This event is planned for the July 2025 release.
The following table lists all the supported properties for the Database search event:
Properties | Example of Values | Comments |
---|---|---|
Search Type |
Database |
|
Search Term |
Art, History |
Send the value as is. |
Results Number |
0,1,2,3, 7025 |
|
A-Z Letter |
A, Z, C, B |
Send the code value. |
A-Z Letter Name |
A, Z, C, B |
Send the value as it appears in the UI. |
Database Category |
Health, Business & Economics |
Send the code value. |
Database Category Name |
Health, Business & Economics |
Send the value as it appears in the UI. |
Language |
Spanish, English |
When users change the language of the A-Z letters, send the value as it appears in the UI. |
Search (Filter Bar)
The user performed a search using the Filter Bar.
This event is planned for the June 2025 release.
The following table lists all the supported properties for the Search event:
Properties | Example of Values | Comments |
---|---|---|
Search Type |
Filter Bar |
The filter bar can be used with 3 different types of filtering: resource type, operator type, and index type |
Search Term |
Art, history.. etc. |
For advanced search, this property is sent only when one line of search is sent. Otherwise, the ‘‘Advanced Query String’ property is sent. |
Results Number |
0,1,2,7589…etc. |
|
Scope Type |
local ,blended, deep_search, |
|
Tab Name |
My_institution, science_library, music, etc. |
The values is the scope code |
Tab Label |
My Institution, Science Library, Music, etc. |
The values will be the scope label as in the UI |
Resource Type |
books, journals, articles, video, etc. |
For Advanced and Filter Bar |
Operator Type |
Contains, Contains Exact Phrase, Starts With, Equals Exact Phrase |
|
Facet used |
Persistent, None, Regular |
This property indicates if a facet is included in the search. |
Index Type |
any, title, creator, subject, course_instructor, etc. |
The values is the index code. |
Index Type Name |
Any field, Title, Creator, Subject, Course Instructor, etc. |
The values will be the label as displayed in the UI |
Scope Label |
Articles And More, All Locations, etc. |
The Label as in the UI |
Scope Name |
Articles And More, All Locations, etc. |
the code value |
Operator Type |
Contains, Contains Exact Phrase, Starts With, Equals Exact Phrase |
|
Search (Journal)
The user performed a search on the Journal Search page.
This event is planned for the June 2025 release.
The following table lists all the supported properties for the Journal Search event:
Properties | Example of Values | Comments |
---|---|---|
Search Type |
Journal |
|
Search Term |
Art, History |
|
Results Number |
0,1,2,7589 |
|
A-Z Letter |
A, Z, C, B |
The letter the user selected. The code value |
A-Z Letter Name |
A, Z, C, B |
The letter the user selected. The UI label |
Journal Category |
Health, Business & Economics |
The category or subcategory the user selected. The code value |
Journal Category Name |
Health, Business & Economics |
The category or subcategory the user selected. The UI label |
Language |
Spanish, English |
When users change the language of the A-Z letters. The UI label |
Search (Natural Language)
The user performed a natural language search.
This event is planned for the June 2025 release.
The following table lists all the supported properties for the Natural Language Search event:
Properties | Example of Values | Comments |
---|---|---|
Search Type |
Natural Language |
|
Search Term |
Art, History |
. |
Results Number |
0,1,2,758 |
|
Natural Language Actions |
1. Search 2. Click Recent Search 2. Clear Search 3. Clear Recent Search 4. Open Search Panel 5. Edit 6. Click Generated Query |
|
Generated Query |
I (AND) want to know (AND) |
Send the value as is. Send this property only with the Click Generated Query action |
Tab Name |
My_institution, science_library, music, etc. |
The value is the scope code. |
Tab Label |
My Institution, Science Library, Music |
The values will be the scope label as in the UI. |
Scope Name |
Articles And More, All Locations |
Send the code value. |
Scope Label |
Articles And More, All Locations |
Send the Label as in the UI. |
Search (Newspapers)
The user performed a search with Newspapers Search.
This event is planned for the July 2025 release.
The following table lists all the supported properties for the Newspapers Search event:
Properties | Example of Values | Comments |
---|---|---|
Search Type |
Newspapers |
|
Search Term |
Art, History |
Send the value as is. |
Results Number |
0, 1, 2, 3, 7025 |
|
Featured Newspaper |
NYT, WaPos, LAT |
Sending the code value. |
Featured Newspaper Name |
New York Times, Washington Post, Los Angeles Times |
Sending the label of the UI. |
Search History Actions
The following table lists all the supported properties for the Search History Actions event:
Properties | Example of Values | Comments |
---|---|---|
Search History Action Type |
Save Search, Remove Search |
|
Search History Count |
1,2,3,4... |
the amount of the searches the user saved or removed |
Search History Term |
Art ... etc Mix |
1. In case of bulk action send the value: Mix 2. The name of the search for basic and filter bar search or 3. In case of a single line in the advanced search |
Search History Query String |
any contains Should trees have standing AND creator contains stone, Mix |
1. in case of bulk action send the value: Mix 2. Send only with Advanced search |
Session Start\End - Automatic Events
Mixpanel computes sessions automatically from the events, so these events are basically virtual. A session starts when a user performs any event and ends when the user is inactive for some period (default: 30 minutes).
The following table lists all the supported properties for the Session Start\End - Automatic Events event:
Properties | Example of Values | Comments |
---|---|---|
Session Duration |
2,3,4…60 etc. |
In seconds |
Session Event Count |
2,3,4…60 etc. |
The number of events during a session |
Session End Event Name |
Search, Facet Usage, etc. |
The original event name that triggered Session End event |
Session Start Event Name |
Search, Facet Usage, etc. |
The original event name that triggered Session Start Event |
Set Persistent Facets
The following table lists all the supported properties for the Set Persistent Facets event:
Properties | Example of Values | Comments |
---|---|---|
Facets Count |
1,2,3,4... |
|
Facet Method |
Include, Exclude, Mixed |
The mixed refers to a situation when the user selecting a mix of include and exclude at the same time |
Facet Type |
Availability, Resource Type, Subject, etc’ |
sending the value in the code as is |
Facet Type Name |
Availability, Resource Type, Subject, etc’ |
sending the labels as in the ui |
Facet Value |
Available Online, Peer reviewed, Held by library, Etc |
sending the value in the code as is |
Facet Value Name |
Available Online, Peer reviewed, Held by library, Etc |
sending the labels as in the ui |
Settings
The following table lists all the supported properties for the Settings event:
Properties | Example of Values | Comments |
---|---|---|
Setting Type |
1. Personal Settings, 2. Language Selection, 3. Update Credentials, 4. Personal Details , 5. Click Unsaved Changes Popup |
1. Personal Settings - when the user changed any of the toggles 2. Language Selection - when the user selected any of the languages from the languages drop down 3. Personal Details - when the user clicked the save button for updating Personal Details 4. Library Notices Selection - when the user selects any of the library notices. 5. Library Notices Unselecting - when the user deselects any of the library notices. 6. Update Credentials - when the user click the save button on the credentials popup 7. Click Unsaved Changes Popup - when the user Clicks any of the Options from the Unsaved changes popup |
Ui Language |
English, Spanish |
Send only with Language Selection |
Personal Settings Action |
|
Send only with Personal Settings |
Library Notices |
Activity Report, Overdue Notice , etc |
1. Sending the value in the code as is 2. Send only with: - Library Notices Selection - Library Notices Unselecting |
Library Notices Name |
Activity Report, Overdue Notice , etc |
sending the labels as in the ui |
Login Credentials Action |
Updated, Failed |
Send only with Update Credentials |
Personal Details Action |
1. Updated 2. Failed 3. Updated With SMS, 4. Failed With SMS, 5. Updated With Additional Email, 6. Failed With Additional Email, 7. Updated With SMS and Additional Email 8. Failed With SMS and Additional Email 9. Library Notices Selection |
Send only with Personal Settings |
Unsaved Popup Action |
unsavedConfirmStay, unsavedConfirmLeave |
1. Sending the value in the code as is 2. Send only with Click Unsaved Changes Popup |
Unsaved Popup Action Name |
Stay On Page, Leave Page |
1. Sending the labels as in the ui 2. Send only with Click Unsaved Changes Popup |
Sign In
The following table lists all the supported properties for the Sign In event:
Properties | Example of Values | Comments |
---|---|---|
Sign In Method |
Manually, SSO |
1. manually clicked on the sign in button \ method 2. SSO user started to perform action when already is signed in from a different place |
Login Using |
Local, SAML, Login Link 3, Login Link 4, etc. |
In a consortium, the value can be the name of the institution as well from the list in the login component. |
Sign Out
The following table lists all the supported properties for the Sign Out event:
Properties | Example of Values | Comments |
---|---|---|
Sign Out Method |
Manually, Timeout |
1. The user manually selected the sign-out button. 2. The user was signed out due to a time-out action (Primo time-out). |
Sort
The following table lists all the supported properties for the Sort event:
Properties | Example of Values | Comments |
---|---|---|
Sort Type |
Title, Author, Relevance, etc. |
|
Syndetics
The user used a Syndetics recommendation.
This event is planned for the May 2025 release.
The following table lists all the supported properties for the Syndetics Recommendations Action event:
Properties | Example of Values | Comments |
---|---|---|
Syndetics Recommendations Action |
Displayed Side Bar, Displayed Bottom Section, Collapse, Expand |
|
Resource Type |
book, collection, article |
|
Record Title |
hamlet |
|
Record ID |
alma99273228800191 |
User Dashboard Actions
The following table lists all the supported properties for the User Dashboard Actions event:
Properties | Example of Values | Comments |
---|---|---|
UD Action Type |
1. Side Menu Navigation 2. Box Navigation 3. Institution Selection |
1. Side menu : all the action from the side menu 2. Box : all the listed box links 3. Institution : selection from the drop- down |
UD Side Menu Link |
1. Overview 2. Loans 3. Requests 4. Fines and Fees 5. Blocks and Messages 6. Saved Records 7. Saved Searches 8. Search History 9. Settings |
Send the Code value |
UD Side Menu Link Name |
1. Overview 2. Loans 3. Requests 4. Fines and Fees 5. Blocks and Messages 6. Saved Records 7. Saved Searches 8. Search History 9. Settings |
Send the value as in the UI |
UD Box Link |
1. View Messages 2. View All Loans 3. View All Requests 4. View All Saved Records 5. View All Search History 6. View All Saved Searches 7. Single Loan Record 8. Single Request Record 9. Single Fines and Fees Record 10. Single Saved Record 11. Single Saved Search |
Send the Code value |
UD Box Link Name |
1. View Messages 2. View All Loans 3. View All Requests 4. View All Saved Records 5. View All Search History 6. View All Saved Searches 7. Single Loan Record 8. Single Request Record 9. Single Fines and Fees Record 10. Single Saved Record 11. Single Saved Search |
Send the value as in the UI |
UD Institution Name |
Harvard, Toronto University, etc. |
|
UD Institution Code |
001UBC, etc. |
|
User Menu Links
The following table lists all the supported properties for the User Menu Links event:
Properties | Example of Values | Comments |
---|---|---|
User Menu Link |
My Favorites, Search History |
Send the value of the code |
User Menu Link Name |
My Favorites, Search History |
Send the label as in the UI |
Virtual Browse
The following table lists all the supported properties for the Virtual Browse event:
Properties | Example of Values | Comments |
---|---|---|
Record Title |
hamlet |
|
Record ID |
alma99273228800191 |
|