REST API Developer Guide

REST API
Quick Start
Examples
Reference
Versions
Resources by Version
Limits
Describe Global
sObject Basic Information
sObject Describe
sObject Get Deleted
sObject Get Updated
sObject Named Layouts
sObject Rows
sObject Rows by External ID
sObject Blob Retrieve
sObject ApprovalLayouts
sObject CompactLayouts
sObject Describe Layouts
sObject PlatformAction
sObject Quick Actions
sObject Rich Text Image Retrieve
sObject Relationships
sObject Suggested Articles
sObject User Password
Platform Event Schema by Event Name
Platform Event Schema by Schema ID
AppMenu
Compact Layouts
Consent
Consent Write
Embedded Service Configuration Describe
Invocable Actions
List View Describe
List View Results
List Views
Support Knowledge with REST API
Parameterized Search
Portability
Process Approvals
Process Rules
Product Schedules
Query
QueryAll
Quick Actions
Recent List Views
Recently Viewed Items
Record Count
sObject Relevant Items
Retrieve Knowledge Language Settings
Search
Search Scope and Order
Search Result Layouts
Lightning Toggle Metrics
Lightning Usage by App Type
Lightning Usage by Browser
Lightning Usage by Page
Lightning Usage by FlexiPage
Lightning Exit by Page Metrics
Salesforce Scheduler Resources
Search for Records Suggested by Autocomplete and Instant Results
Search Suggested Article Title Matches
Search Suggested Queries
Salesforce Surveys Translation Resources
Tabs
Themes
Composite Resources
Headers
Status Codes and Error Responses
PDF

Newer Version Available

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

Lightning Usage by FlexiPage

Returns 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