Use Event Monitoring to Understand Organization Trends (Generally Available)

Use the SOAP API and REST API resources to retrieve event log files that contain information useful for assessing organizational usage trends and user behavior.
Available in: Enterprise, Performance, Unlimited, and Developer Editions

Note

Note

We anticipate this product will be generally available in the November 2014 to January 2015 time frame. Any unreleased services or features referenced in this or other public statements are not currently available and may not be delivered on time or at all. Customers who purchase Salesforce applications should make their purchase decisions based upon features that are currently available.

Because event log files are accessed through the Force.com SOAP API and REST API, you can integrate log data with your own back-end storage and data marts so that you can correlate data from multiple organizations and across disparate systems easily. 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 organization
  • 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 only generated if there is at least one event of that type for the day. If no events took place, the file won't be generated for that day
  • Log files are available based on CreatedDate for the last 30 days when organizations purchase User Event Monitoring or one day for Developer Edition organizations.
  • All event monitoring logs are exposed to the API through the EventLogFile object, however there is no access through the user interface.
Event monitoring can be used with 28 different file types:
  • Apex Callout
  • Apex Execution
  • Apex SOAP
  • Apex Trigger
  • API
  • Async Report
  • Bulk API
  • Change Set Operation
  • Content Distribution
  • Content Document Link
  • Content Transfer
  • Dashboard
  • Document Attachment Downloads
  • Login
  • Login As
  • Logout
  • MDAPI Operation
  • Multiblock Report
  • Package Install
  • Report
  • Report Export
  • REST API
  • Salesforce1 Adoption (UI Tracking)
  • Sandbox
  • Sites
  • Time-Based Workflow
  • URI
  • Visualforce
See New Objects to learn about the EventLogFile object to use with event monitoring

Example

Example

You can use Workbench to describe event log files. In the Execute text box, type /services/data/v32.0/sobjects/EventLogFile/describe.

Example raw response
{ 
   "actionOverrides" : [ ],
   "activateable" : false,
   "childRelationships" : [ ],
   "compactLayoutable" : false,
   "createable" : false,
   "custom" : false,
   "customSetting" : false,
   "deletable" : false,
   "deprecatedAndHidden" : false,
   "feedEnabled" : false,
   "fields" : [ {
     "autoNumber" : false,
     "byteLength" : 18,
     "calculated" : false,
     "calculatedFormula" : null,
     "cascadeDelete" : false,
     "caseSensitive" : false,
     "controllerName" : null,
     "createable" : false,
     ...
}
Note

Note

Log data schema for each EventType can change. At the start of each release, use the LogFileFieldNames and LogFileFieldTypes fields to validate schema changes for each EventType. In the unlikely case where no log files are generated for 24 hours, contact Salesforce.