Force.com REST API Developer's Guide

Getting Started with the Force.com REST API
Using REST Resources
Using REST API Resources
Getting Information About My Organization
Working with Object Metadata
Working with Records
Working with Searches and Queries
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
Using Composite Resources
REST API Reference
PDF

Newer Version Available

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

Using Event Monitoring

Use the REST API to obtain event monitoring data for understanding your organization’s operational events.
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 Force.com 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 organizations and across disparate systems easily.

Refer to the Object Reference for Salesforce and Force.com for important information about the 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 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 29 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
  • Queued Execution
  • Report
  • Report Export
  • REST API
  • Salesforce1 Adoption (UI Tracking)
  • Sandbox
  • Sites
  • Time-Based Workflow
  • URI
  • Visualforce

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