REST API Developer Guide

Introducing Lightning Platform REST API
Quick Start
Examples
Getting Information About My Organization
Working with Object Metadata
Working with Records
Working with Searches and Queries
Insert or Update Blob Data
Working with Recently Viewed Information
Managing User Passwords
Working with Approval Processes and Process Rules
Using Event Monitoring
Describe Event Monitoring Using REST
Query Event Monitoring Data with REST
Get Event Monitoring Content from a Record
Download Large Event Log Files Using cURL with REST
Delete Event Monitoring Data
Generate Hourly Event Log Files (Beta)
Using Composite Resources
Reference
PDF

Newer Version Available

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

Using Event Monitoring

The examples in this section use REST API event monitoring data that contains information useful for assessing organizational usage trends and user behavior. Because event monitoring is accessed through the Lightning Platform SOAP API and REST API by way of the EventLogFile object, you can integrate log data with your own back-end storage and data marts so that you can correlate data from multiple orgs and across disparate systems easily.

For the supported event types you can use with event monitoring, see Object Reference for Salesforce and Lightning Platform: EventLogFile Object.

Note

When using event monitoring, keep the following in mind.
  • In the unlikely case where no log files are generated for 24 hours, contact Salesforce.
  • Log data is read-only. You can’t insert, update, or delete log data.
  • Use the EventType field to determine which files were generated for your org.
  • LogDate tracks usage activity for a 24-hour period, from 12:00 a.m. to 11:59 p.m. UTC time.
  • An event generates log data in real time. However, log files are generated the day after an event takes place, during nonpeak hours. Therefore, log file data is unavailable for at least one day after an event.
  • CreatedDate tracks when the log file was generated.
  • Log files, represented by the EventType field, are generated only if there is at least one event of that type for the day. If no events took place, the file isn’t generated for that day
  • Log files are available based on CreatedDate for the last 30 days when orgs purchase User Event Monitoring or one day for Developer Edition orgs.
  • All event monitoring logs are exposed to the API through the EventLogFile object, however there is no access through the user interface.

All queries and examples in this section require the “View Event Log Files” and “API Enabled” user permissions. Users with the “View All Data” permission can also view event monitoring data.