Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Lightning Usage by FlexiPage

Returns details about the custom pages viewed most frequently in Lightning Experience. This resource is available in REST API version 44.0 and later.

Use this object with the following APIs:

  • Platform
  • Metadata API
  • Tooling API

Syntax

URI: /services/data/vXX.X/sobjects/LightningUsageByFlexiPageMetrics

Formats: JSON, XML

HTTP methods: GET

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

Example Request

1curl https://MyDomainName.my.salesforce.com/services/data/v67.0/sobjects/LightningUsageByFlexiPageMetrics -H "Authorization: Bearer token"

Example Request Body

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