Newer Version Available

This content describes an older version of this product. View Latest

Lightning Usage by FlexiPage

Return details about the custom pages viewed most frequently in Lightning Experience.

Syntax

URI
/services/data/vXX.X/sobjects/LightningUsageByFlexiPageMetrics
Available since release
44.00
Formats
JSON, XML
HTTP methods
GET
Authentication
Authorization: Bearer token
SOQL query.
Request parameters
Parameter Description
FlexiPageNameOrId Namespace and file name, or Page ID of FlexiPage files.
FlexiPageType The FlexiPage type. For example, record details are displayed using RecordPage" type.
MetricsDate The date the metric was recorded.
RecordCountEPT Number of records for a FlexiPage type, where the valid EPT was recorded.
SumEPT Sum of the EPT values for a record
TotalCount Total records for a type.

Example

This query returns the top 10 most viewed custom pages over the past 7 days.

1SELECT FlexiPageNameOrId FlexiPageNameOrId, SUM(TotalCount) Total FROM LightningUsageByFlexiPageMetrics WHERE MetricsDate = Last_N_DAYS:7 AND (NOT FlexiPageNameOrId = 'unknown unknown') AND (NOT FlexiPageNameOrId = 'unknown | unknown') GROUP BY FlexiPageNameOrId ORDER BY SUM(TotalCount) Desc Limit 10

Usage

Use this object with the following APIs:

  • Platform
  • Metadata API
  • Tooling API