Newer Version Available

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

REST API Event Type

REST API events contain details about REST-specific requests.

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

Fields

Field Details
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”.
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.
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.
Example
Account, Opportunity, Contact, and so on.
EVENT_TYPE
Type
String
Description
The type of event. The value is always RestApi.
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_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. 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.
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
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.
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.
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