Lightning Interactions

Each record in your package usage log that has a custom_entity_type of LightningComponent or LightningPage describes an interaction with your packaged Lightning component or page.

Available in: both Salesforce Classic and Lightning Experience

Available in: Enterprise, Performance, Unlimited, and Developer Editions

Lightning User Interaction

We’re continually improving the recording of Lightning interaction data in package usage logs. Many interactions with your packaged Lightning component or page are available in AppExchange App Analytics, but not all. To determine which interactions we capture for your specific package, compare your packaged components to your App Analytics package usage logs.

Note

When a user interacts with your LightningPage or LightningComponent packaged component, a log_record_type of LightningInteraction is created. Some standard fields are always populated with data. For example, a Lightning component interaction always has app_name and ui_event_source data. Lightning interactions have supplemental fields that are often populated. For example, a Lightning interaction sometimes also has page_app_name and page_context data.

Standard Data	Supplemental Data
`app_name` `ui_event_source` `ui_event_type` `target_ui_element` `parent_ui_element`	`page_app_name` `page_context` `related_list` `page_url`

Lightning Page View

When a user views your Lightning page, a log_record_type of LightningPageView is created. Some standard fields are always populated with data. For example, a Lightning page view always has app_name and page_app_name data. Lightning page views have supplemental fields that are often populated. For example, a Lightning page view sometimes also has page_entity_type and prevpage_url data.

Standard Data	Supplemental Data
`app_name` `page_app_name` `page_context` `page_url`	`page_entity_type` `prevpage_url` `related_list`

Example

Let’s look at an example package usage log record and analyze the Lightning interaction.

1{
2        "timestamp_derived": "2022-11-22T06:17:39.167Z",
3        "log_record_type": "LightningInteraction",
4        "request_id": "TID:7635077000004b3035",
5        "organization_id": "00Dxx0000006H2l",
6        "organization_name": "MyCustomer Inc.",
7        "organization_status": "Demo",
8        "organization_edition": "Enterprise Edition",
9        "organization_country_code": "IN",
10        "organization_language_locale": "en_US",
11        "organization_time_zone": "Australia/Sydney",
12        "organization_instance": "GS0",
13        "organization_type": "Production",
14        "user_id_token": "005-9BwnBWYO5FMn4cZ1sLw7F3LmTpoe8M77GrZOZHL6xQk=",
15        "user_type": "Standard",
16        "package_id": "033xx0000004FqD",
17        "package_version_id": "04txx0000004Idi",
18        "managed_package_namespace": "Acme",
19        "custom_entity": "Acme__Insurance_Agents",
20        "custom_entity_type": "LightningPage",
21        "session_key": "2l4YtFB/RmsRKVsS",
22        "login_key": "fGV6RgVOH3ZCgl2v",
23        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/IP_ADDRESS_REMOVED Safari/537.36",
24        "user_country_code": "US",
25        "user_time_zone": "America/Los_Angeles",
26        "app_name": "one:one",
27        "page_app_name": "Insurance_App",
28        "page_context": "app_flexipage:lwcAppFlexipageWrapper",
29        "ui_event_source": "click",
30        "ui_event_type": "user",
31        "ui_event_sequence_num": "10",
32        "target_ui_element": "setup-app-nav-menu-item-link",
33        "parent_ui_element": "global-setup",
34        "page_url": "/lightning/n/Acme__Insurance_Agents"
35    }

The Acme_Insurance_Agents Lightning page was interacted with as a result of a user action from subscriber org MyCustomer Inc. Specifically, a Lightning interaction took place on the page on 2022-11-22 at 6:17 am.

The key data in this analysis are:

Question	Field	Value
What	`custom_entity` `custom_entity_type` `package_version_id` `managed_package_namespace`	`Acme_Insurance_Agents` `LightningPage` `04txx0000004Idi` `Acme`
Who	`organization_id` `user_id_token`	`00Dxx0000006H2l` `005-9BwnBWYO5FMn4cZ1sLw7F3LmTpoe8M77GrZOZHL6xQk=`
How	`log_record_type`	`LightningInteraction`
When	`timestamp_derived`	`2022-11-22T06:17:39.167Z`

Lightning interaction data is captured on an event by event basis.

Note

Second-Generation Managed Packaging Developer Guide

Lightning Interactions

Lightning User Interaction

Lightning Page View

Example

See Also