Salesforce logSalesforce

API Event Type

API events contain details about your organization’s web services API activity.

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

Fields

Field Details
API_TYPE
Type
String
Description
The type of API request.
Possible values are:
  • D—Apex Class
  • E—SOAP Enterprise
  • I—SOAP Cross Instance
  • M—SOAP Metadata
  • O—Old SOAP
  • P—SOAP Partner
  • S—SOAP Apex
  • T—SOAP Tooling
  • X—XmlRPC
  • f—Feed
  • l—Live Agent
  • p—SOAP ClientSync
API_VERSION
Type
String
Description
The version of the API that’s being used.
For example: 36.0.
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from Salesforce Workbench or AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CLIENT_NAME
Type
String
Description
The name of the client that’s using Salesforce services. This field is an optional parameter that can be passed in API calls. If blank, the caller didn't specify a client in the CallOptions header.
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.
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
The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request.
DB_TOTAL_TIME
Type
Number
Description
The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DB_CPU_TIME. 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 by the request.
For example: Account, Opportunity, Contact, and so on.
EVENT_TYPE
Type
String
Description
The type of event. The value is always API.
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.
For 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.
For example: 00D000000000123.
Example
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.
For 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 are:
  • S—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.
  • F—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.
  • U—Undefined
  • A—Authorization Error
  • R—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.
  • N—Not Found. 404 error.
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.
For example: 150.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case-safe 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.
For example: 00530000009M943
USER_ID_DERIVED
Type
Id
Description
The 18-character case-safe ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_TYPE
Type
String
Description
The category of user license.
Possible values are:
  • CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.
  • CspLitePortal—CSP Lite Portal license. Users whose access is limited because they’re organization customers and access the application through a customer portal or an Experience Cloud site.
  • CustomerSuccess—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.
  • Guest—Users whose access is limited so that your customers can view and interact with your site without logging in.
  • PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy.
  • PowerPartner—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.
  • SelfService—Users whose access is limited because they’re organization customers and access the application through a self-service portal.
  • Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.