Newer Version Available

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

EventLogFile

Represents event log files for event monitoring. The event monitoring product gathers information about your Salesforce org’s operational events, which you can use to analyze usage trends and user behavior. This object is available in API version 32.0 and later.

You can interact with event monitoring data by querying fields on the EventLogFile object (like EventType and LogDate). To view the underlying event data, query the LogFile field. The EventType determines the schema of this field. For more information, see EventLogFile Supported Event Types.

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

Note

For details about event monitoring, see the Trailhead Event Monitoring module or Force.com REST API Developer’s Guide.

Special Access Rules

Accessing this object requires View Event Log Files and API Enabled user permissions. Users with View All Data permission can view event log files.

Supported Calls

query(), retrieve()

Fields

Field Details
EventType
Type
string
Properties
Filter, Group, Restricted picklist, Sort
Description
The event type—API, Login, Report, URI, and so forth. Use to determine which files were generated for your org. For the corresponding LogFile schema, see EventLogFile Supported Event Types.
LogDate
Type
dateTime
Properties
Filter, Sort
Description
The date and time of the log file’s creation.
LogFile
Type
base64
Description
Encoded file data in .csv format. The EventType field defines the schema for this 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.

LogFileFieldNames and LogFileFieldTypes are specific to each EventType. For example, LogFileFieldNames has 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 (String, Id, and so forth).

LogFileFieldNames and LogFileFieldTypes are specific to each EventType. For example, LogFileFieldTypes has 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. You can use this field to plan storage needs for your log files.