Newer Version Available

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

EventLogFile

Represents event log files for event monitoring. This object is available in API version 32.0 and later.

The event monitoring feature gathers information about your Salesforce org’s operational events, which you can use to analyze usage trends and user behavior. 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 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 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 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.

Supported Event Types

The EventType field supports the following events. The following tables serve as a reference for each event and its associated fields. Some common fields, such as CPU_TIME and RUN_TIME, can have null or zero values depending on how the events are generated for a given feature.

The Login and Logout events are available in supported Salesforce editions at no additional cost. Contact Salesforce to purchase the remaining event types.

Note

Apex Callout

Apex Callout events contain details about callouts (external requests) during Apex code execution.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
METHOD
Type
String
Description
The HTTP method of the callout.
Example
GET, POST, PUT, and so on.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
REQUEST_SIZE
Type
Number
Description
The size of the callout request body, in bytes.
RESPONSE_SIZE
Type
Number
Description
The size of the callout response, in bytes.
RUN_TIME
Type
Number
Description
Not used for this event type. Use the TIME field instead.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
SUCCESS
Type
Boolean
Description
1 if the request was successful, and 0 if not.
TIME
Type
Number
Description
The amount of time that the request took in milliseconds (ms).
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
TYPE
Type
String
Description
The type of Apex callout.
Example
REST or AJAX
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
URL
Type
String
Description
The callout endpoint URL.
Example
www.salesforce.com
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Apex Execution

Apex Execution events contain details about Apex classes that are used.

Field Details
CALLOUT_TIME
Type
Number
Description
The execution time of the external Apex calls.
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTRY_POINT
Type
String
Description
The entry point for this Apex execution.
Example
  • GeneralCloner.cloneAndInsertRecords
  • VF- /apex/CloneUser
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
EXEC_TIME
Type
Number
Description
The end-to-end Apex execution time.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
NUMBER_SOQL_QUERIES
Type
Number
Description
The number of SOQL queries that were executed during the event.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
QUIDDITY
Type
String
Description
The type of outer execution associated with this event.
Example
  • A–Old Batch
  • C–Scheduled Apex
  • E–Inbound Email Service
  • F–Future
  • H–Apex REST
  • I–Invocable Action
  • K–Quick Action
  • L–Aura
  • M–Remote Action
  • P–Parallel Batch Apex
  • Q–Queuable
  • R–Synchronous
  • S–Serial Batch Apex
  • T–Apex Tests
  • V–Visualforce
  • W–SOAP Webservices
  • X–Execute Anonymous
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Apex SOAP

Apex SOAP events contain details about Web Services API calls.

Field Details
CLASS_NAME
Type
String
Description
The Apex class name. If the class is part of a managed package, this string includes the package namespace.
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LIMIT_USAGE_PERCENT
Type
Number
Description
The percentage of Apex SOAP calls that were made against the organization’s limit.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
METHOD_NAME
Type
String
Description
The name of the calling Apex method.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
QUERY
Type
String
Description
The SOQL query, if one was performed.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
Possible Values
  • S: Success
  • F: Failure
  • U: Undefined
  • A: Authorization Error
  • R: Redirect
  • N: Not Found
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Apex Trigger

Apex Trigger events contain details about triggers that fire in an organization.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTITY_NAME
Type
String
Description
The name of the object affected by the trigger.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
EXEC_TIME
Type
Number
Description
The end-to-end Apex execution time.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
Possible Values
  • S: Success
  • F: Failure
  • U: Undefined
  • A: Authorization Error
  • R: Redirect
  • N: Not Found
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
TRIGGER_ID
Type
String
Description
The 15-character ID of the trigger that was fired.
TRIGGER_NAME
Type
String
Description
The name of the trigger that was fired.
TRIGGER_TYPE
Type
String
Description
The type of this trigger.
Possible Values
  • AfterInsert
  • AfterUpdate
  • BeforeInsert
  • BeforeUpdate
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

API

API events contain details about your organization’s Force.com Web Services API activity.

Field Details
API_TYPE
Type
String
Description
The type of API request.
Possible Values
  • D: Apex Class
  • E: SOAP Enterprise
  • I: SOAP Cross Instance
  • L: Live Agent
  • M: SOAP Metadata
  • O: Old SOAP
  • P: SOAP Partner
  • R: REST API
  • S: SOAP Apex
  • T: SOAP Tooling
  • X: XmlRPC
API_VERSION
Type
String
Description
The version of the API that’s being used.
Example
36.0
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CLIENT_NAME
Type
String
Description
The name of the client that’s using Salesforce services.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_BLOCKS
Type
Number
Description
Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type
Number
Description
Allows you to monitor trends in database uptime.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTITY_NAME
Type
Set
Description
API objects that are accessed.
Example
Account, Opportunity, Contact, and so on.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
METHOD_NAME
Type
String
Description
The name of the calling Apex method.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
REQUEST_SIZE
Type
Number
Description
The size of the callout request body, in bytes.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
Possible Values
  • S: Success
  • F: Failure
  • U: Undefined
  • A: Authorization Error
  • R: Redirect
  • N: Not Found
RESPONSE_SIZE
Type
Number
Description
The size of the callout response, in bytes.
ROWS_PROCESSED
Type
Number
Description
The number of rows that were processed in the request.
Example
150
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
QUERY
Type
String
Description
The SOQL query, if one was performed.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Asynchronous Report Run

Asynchronous Report Run events are created for reporting requests that are scheduled. This category includes dashboard refreshes, asynchronous reports, schedule reports, and analytics snapshots.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DASHBOARD_ID
Type
String
Description
The 15-character ID of the dashboard that was run.
DASHBOARD_ID_DERIVED
Type
String
Description
The 18-character case insensitive ID of the dashboard that was run.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
DB_BLOCKS
Type
Number
Description
Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type
Number
Description
Allows you to monitor trends in database uptime.
DISPLAY_TYPE
Type
String
Description
The report display type, indicating the run mode of the report.
Possible Values
  • D: Dashboard
  • S: Show Details
  • H: Hide Details
ENTITY_NAME
Type
String
Description
The name of the object affected by the trigger.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
NUMBER_BUCKETS
Type
Number
Description
The number of buckets that were used in the report.
NUMBER_COLUMNS
Type
Number
Description
The number of columns in the report.
NUMBER_EXCEPTION_FILTERS
Type
Number
Description
The number of exception filters that are used in the report.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
RENDERING_TYPE
Type
String
Description
The report rendering type, describing the format of the report output.
Possible Values
  • W: Web (HTML)
  • E: Email
  • P: Printable
  • X: Excel
  • C: Comma-separated values (CSV)
  • J: JavaScript Object Notation (JSON)
REPORT_ID
Type
Id
Description
The 15-character ID of the report that was run.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
Possible Values
  • S: Success
  • F: Failure
  • U: Undefined
  • A: Authorization Error
  • R: Redirect
  • N: Not Found
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
SORT
Type
String
Description
The sort column and order that was used in the report.
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Bulk API

Bulk API events contain details about Bulk API requests.

Field Details
BATCH_ID
Type
String
Description
The 15-character ID of the Bulk API batch.
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
ENTITY_TYPE
Type
String
Description
The type of entity that the Bulk API used.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
JOB_ID
Type
String
Description
The 15-character ID of the Bulk API job.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
MESSAGE
Type
EscapedString
Description
Any success or error message that’s associated with the request.
NUMBER_FAILURES
Type
Number
Description
The number of failures that were returned with the request.
OPERATION_TYPE
Type
String
Description
The type of Bulk API operation that was performed.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
ROWS_PROCESSED
Type
Number
Description
The number of rows that were processed in the request.
Example
150
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
SUCCESS
Type
Boolean
Description
Whether the batch was successful.
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943

Change Set Operation

Change Set Operation events contain information from change set migrations.

Field Details
CHANGE_SET_NAME
Type
String
Description
The name of the change set.
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
OPERATION
Type
String
Description
The operation that’s being performed.
Possible Values
  • DEPLOY
  • RETRIEVE
  • LIST
  • DESCRIBE
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TARGET_ORG_ID
Type
Id
Description
The 15-character ID of the organization that’s receiving the change set.
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Console

Console events contain information about the performance and use of Salesforce Consoles. The Console events are logged whenever a Console tab is opened with a sidebar component. Outside of that, when Console tabs are opened, a regular view record detail event is served just like in Salesforce Classic.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
COMPONENT_ID
Type
Id
Description
The 15-character ID of the component.
COMPONENT_ID_DERIVED
Type
Id
Description
The 18-character, case-insensitive ID of the component.
CONSOLE_ID
Type
Id
Description
The 15-character ID of the console.
CONSOLE_ID_DERIVED
Type
Id
Description
The 18-character, case-insensitive ID of the console.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
RECORD_ID
Type
Id
Description
The 15-character ID of the record that’s associated with the console.
RECORD_ID_DERIVED
Type
Id
Description
The 18-character, case-insensitive ID of the record that’s associated with the console.
RELATED_ENTITY_ID
Type
Id
Description
The 15-character ID of the record that’s associated with the delivery distribution.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
Possible Values
  • S: Success
  • F: Failure
  • U: Undefined
  • A: Authorization Error
  • R: Redirect
  • N: Not Found
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Content Distribution

Content Distribution events contain information about content distributions and deliveries to users.

Field Details
ACTION
Type
String
Description
The action that’s used when a delivery is viewed.
Possible Values
  • VIEW
  • INSERT
  • UPDATE
DELIVERY_ID
Type
Id
Description
The 15-character ID of the content delivery.
DELIVERY_LOCATION
Type
String
Description
The location of the delivery.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
RELATED_ENTITY_ID
Type
Id
Description
The 15-character ID of the record that’s associated with the delivery distribution.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
VERSION_ID
Type
Id
Description
The 15-character ID of the content version.

Content Transfer

Content Transfer events contain information about content transfer events, such as downloads, uploads, and previews.

Field Details
DOCUMENT_ID
Type
Id
Description
The 15-character ID of the document that’s being shared.
DOCUMENT_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the document that’s being shared.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
FILE_PREVIEW_TYPE
Type
String
Description
The content type of the file version.
FILE_TYPE
Type
String
Description
The content type of the file preview.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
SIZE_BYTES
Type
Number
Description
The size of the file transfer, in bytes.
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
TRANSACTION_TYPE
Type
String
Description
The operation that was performed.
Possible Values
  • VersionDownloadAction and VersionDownloadApi represent downloads via the user interface and API respectively.
  • VersionRenditionDownload represents a file preview action.
  • saveVersion represents a file that’s being uploaded.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0
VERSION_ID
Type
Id
Description
The 15-character ID of the content version.
VERSION_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the content version.

Dashboard

Dashboard events contain details about dashboards that users view.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DASHBOARD_COMPONENT_ID
Type
Id
Description
The 15-character ID of the dashboard component.
DASHBOARD_ID
Type
String
Description
The 15-character ID of the dashboard that was run.
DASHBOARD_ID_DERIVED
Type
String
Description
The 18-character case insensitive ID of the dashboard that was run.
DASHBOARD_TYPE
Type
String
Description
The type of dashboard.
Possible Values
  • R: Run as running user
  • C: Run as context user
  • S: Run as specific user
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
IS_SCHEDULED
Type
Boolean
Description
The value is true if the dashboard is a scheduled dashboard.
IS_SUCCESS
Type
Boolean
Description
1 if the dashboard component ran successfully, 0 if it didn’t.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REPORT_ID
Type
Id
Description
The 15-character ID of the report that was run.
REPORT_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the report that was run.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Document Attachment Downloads

Document Attachment Downloads events contain details of document and attachment downloads.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
ENTITY_ID
Type
Id
Description
The 15-character ID of the entity that’s associated with the document or attachment.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
FILE_NAME
Type
String
Description
The name of the file or attachment.
FILE_TYPE
Type
String
Description
The type of the file or attachment.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943

Login As

Login As events contain details about what a Salesforce admin did while logged in as another user.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DELEGATED_USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or API. In this case, the user who’s doing the impersonation.
DELEGATED_USER_ID_DERIVED
Type
Id
Description
The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or API. In this case, the user who’s doing the impersonation.
DELEGATED_USER_NAME
Type
String
Description
The username of the user who’s using Salesforce services through the UI or API. In this case, the user who’s doing the impersonation.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Login

Login events contain details about your org’s user login history.

Field Details
API_TYPE
Type
String
Description
The type of API request.
Possible Values
  • D: Apex Class
  • E: SOAP Enterprise
  • I: SOAP Cross Instance
  • L: Live Agent
  • M: SOAP Metadata
  • O: Old SOAP
  • P: SOAP Partner
  • R: REST API
  • S: SOAP Apex
  • T: SOAP Tooling
  • X: XmlRPC
API_VERSION
Type
String
Description
The version of the API that’s being used.
Example
36.0
BROWSER_TYPE
Type
String
Description
The browser used for login.
Example Values
  • 10011000: Internet Explorer Desktop 11
  • 10011001: Internet Explorer Mobile 11
  • 11035000: Firefox Desktop 35
  • 11035001: Firefox Mobile 35
  • 13050000: Chrome Desktop 50
  • 13050001: Chrome Mobile 50
  • 14012000: Safari Desktop 12
  • 14012001: Safari Mobile 12
CIPHER_SUITE
Type
String
Description
The TLS cipher suite used for the login. Values are OpenSSL-style cipher suite names, with hyphen delimiters. For more information, see OpenSSL Cryptography and SSL/TLS Toolkit.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
LOGIN_STATUS
Type
String
Description
The status of the login attempt. For successful logins, the value is LOGIN_NO_ERROR. All other values indicate errors or authentication issues. For details, see Login Event Type — LOGIN_STATUS Values.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
Possible Values
  • S: Success
  • F: Failure
  • U: Undefined
  • A: Authorization Error
  • R: Redirect
  • N: Not Found
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
SOURCE_IP
Type
IP
Description
The source IP of the login request.
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
TLS_PROTOCOL
Type
String
Description
The TLS protocol used for the login.
Example
There are 3 possible values.
  • 1.0
  • 1.1
  • 1.2
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0
USER_NAME
Type
String
Description
The username that’s used for login.

Logout

Logout events contain details of user logouts.

Field Details
API_TYPE
Type
String
Description
The type of API request.
Possible Values
  • D: Apex Class
  • E: SOAP Enterprise
  • I: SOAP Cross Instance
  • L: Live Agent
  • M: SOAP Metadata
  • O: Old SOAP
  • P: SOAP Partner
  • R: REST API
  • S: SOAP Apex
  • T: SOAP Tooling
  • X: XmlRPC
API_VERSION
Type
String
Description
The version of the API that’s being used.
Example
36.0
APP_TYPE
Type
Number
Description
The application type that was in use upon logging out.
Example Values
  • 1007: SFDC Application
  • 1014: Live Agent
  • 2501: CTI
  • 2514: OAuth
  • 3475: SFDC Partner Portal
BROWSER_TYPE
Type
String
Description
The browser used for login.
Example Values
  • 10011000: Internet Explorer Desktop 11
  • 10011001: Internet Explorer Mobile 11
  • 11035000: Firefox Desktop 35
  • 11035001: Firefox Mobile 35
  • 13050000: Chrome Desktop 50
  • 13050001: Chrome Mobile 50
  • 14012000: Safari Desktop 12
  • 14012001: Safari Mobile 12
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CLIENT_VERSION
Type
Number
Description
The version of the client that was in use upon logging out.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
PLATFORM_TYPE
Type
Number
Description
The code for the client platform. If a timeout caused the logout, this field is null.
Example Values
  • 1000: Windows
  • 2003: Macintosh/Apple OSX
  • 5005: Android
  • 5006: iPhone
  • 5007: iPad
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RESOLUTION_TYPE
Type
Number
Description
The screen resolution of the client. If a timeout caused the logout, this field is null.
SESSION_LEVEL
Type
String
Description
The security level of the session that was used when logging out.
Possible Values
  • 1: Standard Session
  • 2: High-Assurance Session
SESSION_TYPE
Type
String
Description
The session type that was used when logging out.
Possible Values
  • A: API
  • I: APIOnlyUser
  • N: ChatterNetworks
  • Z: ChatterNetworksAPIOnly
  • C: Content
  • P: OauthApprovalUI
  • O: Oauth2
  • T: SiteStudio
  • R: SitePreview
  • S: SubstituteUser
  • B: TempContentExchange
  • G: TempOauthAccessTokenFrontdoor
  • Y: TempVisualforceExchange
  • F: TempUIFrontdoor
  • U: UI
  • E: UserSite
  • V: Visualforce
  • W: WDC_API
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_INITIATED_LOGOUT
Type
Boolean
Description
The value is 1 if the user intentionally logged out of the organization by clicking the Logout button. If the user’s session timed out due to inactivity or another implicit logout action, the value is 0.
USER_NAME
Type
String
Description
The username that’s used for login.
USER_TYPE
Type
String
Description
The category of user license of the user that logged out.
Possible Values
  • S: Standard
  • P: Partner
  • p: Customer Portal Manager
  • C: Customer Portal User
  • O: Power Custom
  • o: Custom
  • L: Package License Manager
  • X: Black Tab User
  • N: Salesforce to Salesforce
  • G: Guest
  • D: External Who
  • A: Automated Process
  • b: High Volume Portal
  • n: CSN Only
  • F: Self-Service

Metadata API Operation

Metadata API Operation events contain details of Metadata API retrieval and deployment requests.

Field Details
API_VERSION
Type
String
Description
The version of the API that’s being used.
Example
36.0
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
OPERATION
Type
String
Description
The operation that’s being performed.
Possible Values
  • DEPLOY
  • RETRIEVE
  • LIST
  • DESCRIBE
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Multiblock Report

Multiblock Report events contain details about Joined Report reports.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
HAS_CHART
Type
Boolean
Description
True if the report has a chart.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
MASTER_REPORT_ID
Type
String
Description
The 15-character ID of the master report.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
Possible Values
  • S: Success
  • F: Failure
  • U: Undefined
  • A: Authorization Error
  • R: Redirect
  • N: Not Found
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Package Install

Package Install events contain details about package installation in the organization.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
FAILURE_TYPE
Type
String
Description
A general categorization of any error that’s encountered.
IS_MANAGED
Type
Boolean
Description
True if the operation is performed on a managed package.
IS_PUSH
Type
Boolean
Description
True if the package was installed as a result of a push upgrade.
IS_RELEASED
Type
Boolean
Description
True if the operation is performed on a released package.
IS_SUCCESSFUL
Type
Boolean
Description
True if the package was successfully installed.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
OPERATION_TYPE
Type
String
Description
The type of package operation.
Possible Values
  • INSTALL
  • UPGRADE
  • EXPORT
  • UNINSTALL
  • VALIDATE_PACKAGE
  • INIT_EXPORT_PKG_CONTROLLER
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
PACKAGE_NAME
Type
String
Description
The name of the package that’s being installed.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Queued Execution

Queued Execution events contain details about queued executions—for example, batch Apex.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds that it took to complete the batch apex request. This field indicates the amount of activity taking place in the app server layer, allowing you to identify pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTRY_POINT
Type
String
Description
The name of the Apex class that serves as the execution point for the batch job.
Example
TaskPhoneExtensionBatchUpdate
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
JOB_ID
Type
String
Description
The ID of the batch Apex job.
Example
7073000000lDquo
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943

Report Export

Report Export events contain details about reports that a user exported.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CLIENT_INFO
Type
String
Description
Information about the client that’s using Salesforce services.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REPORT_DESCRIPTION
Type
String
Description
Information about the report that was run.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

REST API

REST API events contain details about REST-specific requests.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_BLOCKS
Type
Number
Description
Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type
Number
Description
Allows you to monitor trends in database uptime.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
ENTITY_NAME
Type
Set
Description
API objects that are accessed.
Example
Account, Opportunity, Contact, and so on.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
MEDIA_TYPE
Type
String
Description
The media type of the response.
METHOD
Type
String
Description
The HTTP method of the request—GET, POST, PUT, and so on.
NUMBER_FIELDS
Type
Number
Description
The number of fields or columns, where applicable.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
Possible Values
  • S: Success
  • F: Failure
  • U: Undefined
  • A: Authorization Error
  • R: Redirect
  • N: Not Found
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
ROWS_PROCESSED
Type
Number
Description
The number of rows that were processed in the request.
Example
150
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
STATUS_CODE
Type
Number
Description
The HTTP status code for the response.
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_AGENT
Type
Number
Description
The numeric code for the type of client used to make the request (for example, the browser, application, or API).
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Sandbox

Sandbox events contain details about sandbox copies.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CURRENT_SANDBOX_ORG_ID
Type
Id
Description
The 15-character ID of the current sandbox organization.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
PENDING_SANDBOX_ORG_ID
Type
Id
Description
The 15-character ID of the target sandbox org.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
SANDBOX_ID
Type
Id
Description
The 15-character ID of the sandbox organization.
STATUS
Type
String
Description
The status of the sandbox copy.
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943

Sites

Sites events contain details of Site.com requests. Requests can originate from the browser (UI) or the API.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
HTTP_HEADERS
Type
String
Description
The HTTP headers that were sent in the request.
METHOD
Type
String
Description
The HTTP method of the request—GET, POST, PUT, and so on.
IS_API
Type
Boolean
Description
True if this page was an API or Web Services request.
IS_ERROR
Type
Boolean
Description
True if this page was an error page.
IS_FIRST_REQUEST
Type
Boolean
Description
1 if this page is the first Visualforce transaction in the request, or 0 if it isn't.
IS_GUEST
Type
Boolean
Description
True if this page was a guest (unauthenticated) request.
IS_SECURE
Type
Boolean
Description
True if this request is secure.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
PAGE_NAME
Type
String
Description
The name of the Visualforce page that was requested.
QUERY
Type
String
Description
The SOQL query, if one was performed.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
Possible Values
  • S: Success
  • F: Failure
  • U: Undefined
  • A: Authorization Error
  • R: Redirect
  • N: Not Found
REQUEST_TYPE
Type
String
Description
The request type.
Possible Values
  • page: a normal request for a page
  • content_UI: a content request for a page that originated in the user interface
  • content_apex: a content request initiated by an Apex call
  • PDF_UI: a request for a page in PDF format through the user interface
  • PDF_apex: a request for PDF format by an Apex call (usually a Web Service call)
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
SITE_ID
Type
Id
Description
The 15-character ID of the Site.com site.
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
URI_ID_DERIVED
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Time-Based Workflow

Time-Based Workflow events contain details about queue activity monitoring.

Field Details
DATA
Type
String
Description
The record details of time queue activity.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOG_GROUP_ID
Type
String
Description
Marks log records that are committed or rolled back.
NUMBER_OF_RECORDS
Type
Number
Description
The number of processed records.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
TYPE
Type
String
Description
The type of Apex callout.
Example
REST or AJAX

Transaction Security

Transaction Security events contain details about policy execution.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVALUATION_TIME_MS
Type
Number
Description
The time in milliseconds used to evaluate the policy.
EVENT_TIMESTAMP
Type
String
Description
The time at which the Transaction Security event was generated in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). This value might be earlier than TIMESTAMP_DERIVED by the amount of time taken to log the event.
Example
2015-07-27T11:32:59.555Z
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
POLICY_ID
Type
Id
Description
The 15-character ID of the policy being evaluated.
Example
00530000009M943
POLICY_ID_DERIVED
Type
Id
Description
The 18-character case-insensitive ID of the policy being evaluated.
Example
00590000000I1SNIA0
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RESULT
Type
String
Description
The outcome of evaluating the policy.
Example
TRIGGERED or NOT TRIGGERED
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The time the event was logged in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). This value may be later than EVENT_TIMESTAMP by the amount of time between when the event occurred and when it was logged.
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

UI Tracking

UI Tracking events contain details about user interactions with the mobile UI.

Field Details
ACTION
Type
EscapedString
Description
The hierarchical user action.
ACTION_LOCATION
Type
String
Description
The name of the component where the user action occurred.
ACTION_TYPE
Type
String
Description
The database action that’s associated with the user action.
Possible Values
Database actions, including:
  • Create
  • Update
  • Delete
  • Convert
APP_NAME
Type
EscapedString
Description
The name of the application that the user accessed.
BROWSER_NAME
Type
String
Description
The name of the browser that's accessed by the user.
BROWSER_VERSION
Type
String
Description
The browser version that's accessed by the user.
CARRIER
Type
String
Description
The name of the cellular service provider.
CLIENT
Type
EscapedString
Description
The context of access.
Example
Phone, tablet, desktop, and so on.
CLIENT_ID
Type
String
Description
The API client ID.
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CONNECTION_TYPE
Type
String
Description
The type of the connection.
Possible Values
  • WIFI

  • CDMA1x

  • CDMA

  • EDGE

  • EVDO0

  • EVDOA

  • EVDOB

  • GPRS

  • HSDPA

  • HSUPA

  • HRPD

  • LTE

DELTA
Type
Number
Description
The elapsed time between the start (START_TIME) and end (END_TIME) of the event in milliseconds.
DEVICE_ID
Type
String
Description
The unique identifier used to identify a device when tracking events. DEVICE_ID is a generated value that’s created when the app is initially run after installation.
END_TIME
Type
Number
Description
The end time of the event in Unix time (milliseconds since 00:00:00 UTC on January 1, 1970).
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOCATION
Type
EscapedString
Description
The hierarchical location.
NETWORK_ID
Type
Id
Description
The network ID of the request.
NUMBER1
Type
Number
Description
The record of a numeric value based on the operation. For example, the number of results returned by a search.
NUMBER2
Type
Number
Description
The record of a numeric value based on operation, but for multiple values.
Example
NUMBER1 items selected in a list containing NUMBER2 items.
OBJECT_TYPE
Type
String
Description
The API name of the record in the action.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
OS_NAME
Type
String
Description
The operating system name.
OS_VERSION
Type
String
Description
The operating system version.
PAGE_OPTION
Type
String
Description
A comma-separated list of additional information about the current page.
Example
isVisualforce
RECORD_ID
Type
Id
Description
The ID of the record the user accessed.
RECORD_TYPE_ID
Type
Id
Description
The ID of the record type the user accessed.
REFERRER
Type
EscapedString
Description
The HTTP referrer header.
REQUEST_METHOD
Type
String
Description
The HTTP request method.
SDK_APP_NAME
Type
String
Description
The name of the mobile SDK application that’s installed on the device.
Example
Salesforce1
SDK_APP_TYPE
Type
String
Description
The mobile SDK application type.
Example
Native, hybrid, and so on.
SDK_APP_VERSION
Type
String
Description
The mobile SDK application version.
Example
5.0
SDK_MODEL
Type
String
Description
The model of the mobile SDK application that’s installed on the device.
Example
Salesforce1
SDK_VERSION
Type
String
Description
The mobile SDK version.
Example
2.1.0
SESSION_ID
Type
String
Description
The user’s unique session ID. You can use the ID to identify all UI Tracking events within a session.
Example
[C@2f71c8e1
SIGNAL_STRENGTH
Type
Number
Description
The cellular signal strength.
START_TIME
Type
Number
Description
The start time of the event in Unix time (milliseconds since 00:00:00 UTC on January 1, 1970).
STATUS
Type
Boolean
Description
Indicates whether an error was logged. Information is logged in data.
TARGET
Type
EscapedString
Description
The request target.
TARGET2
Type
EscapedString
Description
Additional information for the request target.
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
UNIQUE_PAGE_ID
Type
String
Description
The unique request ID for all the requests from 1 page.
USAGE_TIMESTAMP
Type
String
Description
The time when the usage occurred. Format: YYYYMMDDHHMM​SS.sss.
USER_AGENT
Type
Escaped String
Description
The numeric code for the type of client used to make the request (for example, the browser, application, or API) as a string.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0
USER_TYPE
Type
String
Description
The user license of the user who’s accessing Salesforce services through the UI or the API.
Possible Values
  • S: Standard
  • P: Partner
  • p: Customer Portal Manager
  • C: Customer Portal User
  • O: Power Custom
  • o: Custom
  • L: Package License Manager
  • X: Black Tab User
  • N: Salesforce to Salesforce
  • G: Guest
  • D: External Who
  • A: Automated Process
  • b: High Volume Portal
  • n: CSN Only
  • F: Self-Service

URI

URI events contain details about user interaction with the web browser UI.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_BLOCKS
Type
Number
Description
Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type
Number
Description
Allows you to monitor trends in database uptime.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
REFERRER_URI
Type
String
Description
The referring URI of the page that’s receiving the request.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
Possible Values
  • S: Success
  • F: Failure
  • U: Undefined
  • A: Authorization Error
  • R: Redirect
  • N: Not Found
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request. For more granular URI information for Lightning Experience and Salesforce1, see the Lightning Error, Lightning Interaction, Lightning Page View, and Lightning Performance event types.
Examples
/aura (Lightning Experience), /app/one.app (Lightning Experience), /home/home.jsp (Salesforce Classic)
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0

Visualforce Request

VISUALFORCE__REQUEST_EVENT events contain details of Visualforce requests. Requests can originate from the browser (UI) or the API.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CONTROLLER_TYPE
Type
Number
Description
The type of controller that’s used by the requested Visualforce page.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
DB_BLOCKS
Type
Number
Description
Indicates how much activity is occurring in the database. A high value for this field suggests that adding indexes or filters on your queries would benefit performance.
DB_CPU_TIME
Type
Number
Description
Allows you to monitor trends in database uptime.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Compare this field to CPU_TIME to determine whether performance issues are occurring in the database layer or in your own code.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
HTTP_METHOD
Type
String
Description
The HTTP method of the request—GET, POST, PUT, and so on.
IS_AJAX_REQUEST
Type
Boolean
Description
The value is true if the request is a partial page request.
IS_FIRST_REQUEST
Type
Boolean
Description
1 if this page is the first Visualforce transaction in the request, or 0 if it isn't.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
MANAGED_PACKAGE_NAMESPACE
Type
String
Description
If the page is part of a managed package, the namespace of that package.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
PAGE_NAME
Type
String
Description
The name of the Visualforce page that was requested.
QUERY
Type
String
Description
The SOQL query, if one was performed.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
REQUEST_SIZE
Type
Number
Description
The size of the request body, in bytes.
REQUEST_STATUS
Type
String
Description
The status of the request for a page view or user interface action.
Possible Values
  • S: Success
  • F: Failure
  • U: Undefined
  • A: Authorization Error
  • R: Redirect
  • N: Not Found
REQUEST_TYPE
Type
String
Description
The request type.
Possible Values
  • page: a normal request for a page
  • content_UI: a content request for a page that originated in the user interface
  • content_apex: a content request initiated by an Apex call
  • PDF_UI: a request for a page in PDF format through the user interface
  • PDF_apex: a request for PDF format by an Apex call (usually a Web Service call)
RESPONSE_SIZE
Type
Number
Description
The size of the response, in bytes.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_AGENT
Type
Number
Description
The numeric code for the type of client used to make the request (for example, the browser, application, or API).
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
VIEW_STATE_SIZE
Type
Number
Description
The size of the Visualforce view state, in bytes.

Wave Change

Wave Change events represent route or page changes made in the Salesforce Analytics user interface.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
IS_NEW
Type
Boolean
Description
If the change routes to a new page, the value of this field is true. If it routes to an existing page, this field is false.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
RECORD_ID
Type
String
Description
The Salesforce ID of the Analytics object.
REOPEN_COUNT
Type
Number
Description
If IS_NEW is false, the number of times that an existing page opens.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
TYPE
Type
String
Description
The Analytics object type.
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
WAVE_SESSION_ID
Type
String
Description
The ID of a particular session of Wave. Use this field to determine which log lines originated from a particular session.
WAVE_TIMESTAMP
Type
Number
Description
The time at which this log line was generated.

Wave Interaction

Wave Interaction events track user interactions with the Analytics user interface made via the browser.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer, highlighting pieces of Apex or Visualforce code that need refactoring.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
NUM_CLICKS
Type
Number
Description
The number of clicks performed on a page in the Wave user interface.
NUM_SESSIONS
Type
Number
Description
The number of times a user returned to a particular page.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
READ_TIME
Type
Number
Description
The amount of time a user spent on a particular tab.
RECORD_ID
Type
String
Description
The Salesforce ID of the Analytics object.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
TOTAL_TIME
Type
Number
Description
The total amount of time a tab was open in milliseconds.
TYPE
Type
String
Description
The Analytics object type.
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example
00590000000I1SNIA0
WAVE_SESSION_ID
Type
String
Description
The ID of a particular session of Wave.
WAVE_TIMESTAMP
Type
Number
Description
The time at which this log line was generated.

Wave Performance

Wave Performance events help you track trends in your Analytics performance.

Field Details
CLIENT_IP
Type
IP
Description
The IP address of the client that’s using Salesforce services.
Example
96.43.144.26
EPT
Type
Number
Description
The experienced page time in milliseconds.
EVENT_TYPE
Type
String
Description
The type of event.
Example
ReportExport, URI, UITracking, API, RestApi, and so on.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example
GeJCsym5eyvtEK2I
NAME
Type
String
Description
The asset title or query string.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
Example
00D000000000123
QUERY_ID
Type
String
Description
The ID of the Wave query.
RECORD_ID
Type
String
Description
The Salesforce ID of the Analytics object.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example
3nWgxWbDKWWDIk0FKfF5DV
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The string that ties together all events for a particular activity session. For example, URI events while the user is interacting with an Accounts page.
Example
d7DEq/ANa7nNZZVD
TAB_ID
Type
String
Description
The ID of the particular Wave tab in the user interface.
TIMESTAMP
Type
String
Description
The access time of Salesforce services.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
Datetime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ)
Example
2015-07-27T11:32:59.555Z
TYPE
Type
String
Description
The Analytics object type.
UI_RENDER_TIME
Type
String
Description
The amount of time that it took for the user interface to render.
URI
Type
String
Description
The URI of the page that’s receiving the request.
Example
/home/home.jsp
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
Example
00530000009M943
WAVE_SESSION_ID
Type
String
Description
The ID of a particular session of Wave.
WAVE_TIMESTAMP
Type
Number
Description
The time at which this log line was generated.