Object Reference for Salesforce and Force.com

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

EventLogFile

Represents event log files for event monitoring.

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.

Note

The event monitoring feature allows you to gather information about your Salesforce organization’s operational events, which you can use to analyze usage trends and user behavior. You can interact with event monitoring data using the EventLogFile object. This object is available in API versions 29.0 and later.

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.

Note

Refer to the Force.com REST API Developer’s Guide for additional details about event monitoring.

Special Access Rules

You must have “View Event Log Files” and “API Enabled” user permissions to access this object. Users with “View All Data” will automatically be able to view event log files.

Supported Calls

query(), retrieve()

Fields

Field Details
EventType
Type
string
Properties
Filter, Group, Restricted picklist, Sort
Description
The event type, such as API, Login, Report, URI and so forth. Use to determine which files were generated for your organization.
LogDate
Type
dateTime
Properties
Filter, Sort
Description
The log creation date.
LogFile
Type
base64
Description
Encoded file data.
LogFileContentType
Type
string
Properties
Filter, Group, Sort
Description
The content type of the log file; always .csv.
LogFileFieldNames
Type
string
Properties
Nillable
Description
The ordered list of fields in the log file data. For example, EVENT_TYPE, TIMESTAMP, and so forth.

LogFileFieldNames and LogFileFieldTypes are specific to each EventType. For example, LogFileFieldNames will have a different value for an API EventType and a Login EventType.

Note
LogFileFieldTypes
Type
string
Properties
Nillable
Description
The ordered list of field types in the log file data. For example, String, Id, and so forth.

LogFileFieldNames and LogFileFieldTypes are specific to each EventType. For example, LogFileFieldTypes will have a different value for an API EventType and a Login EventType.

Note
LogFileLength
Type
double
Properties
Filter, Sort
Description
The log file length in bytes.