---
schema_version: "1"
id: e9d8e44229abb4b39a7c32648a22656967a36d165876dcbb5bb3cb7326402855
title: SOAP API Event Type
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_api.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_api.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: f458d365a88bf408b4edb8bd79fcb02193e244c4e971f23be50adc9ed8feb72d
description: SOAP API events contain details about your org's SOAP API request activity.
---
# SOAP API Event Type

SOAP API events contain details about your org's SOAP API request activity.

For details about event monitoring, see the [Trailhead Event Monitoring module](https://trailhead.salesforce.com/en/modules/event_monitoring/units/event_monitoring_intro "HTML (New Window)") or [REST API Developer’s Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/using_resources_event_log_files.htm "HTML (New Window)").

## Fields

<table class="featureTable sort_table" summary=""><tbody class="tbody"><tr><td class="entry"><strong class="ph b">Field</strong></td><td class="entry"><strong class="ph b">Details</strong></td></tr><tr><td class="entry"><span class="keyword parmname">API_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The type of API request.</dd><dd class="dd">Possible values are:<ul class="ul bulletList"><li class="li"><samp class="codeph nolang">D</samp>—Apex Class</li><li class="li"><samp class="codeph nolang">E</samp>—SOAP Enterprise</li><li class="li"><samp class="codeph nolang">M</samp>—SOAP Metadata</li><li class="li"><samp class="codeph nolang">P</samp>—SOAP Partner</li><li class="li"><samp class="codeph nolang">S</samp>—SOAP Apex</li><li class="li"><samp class="codeph nolang">T</samp>—SOAP Tooling</li><li class="li"><samp class="codeph nolang">f</samp>—Feed</li><li class="li"><samp class="codeph nolang">l</samp>—Live Agent</li><li class="li"><samp class="codeph nolang">p</samp>—SOAP ClientSync</li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">API_VERSION</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The version of the API that’s being used.</dd><dd class="dd">For example: <samp class="codeph nolang">36.0</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_IP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.</dd><dd class="dd">For example: <samp class="codeph nolang">96.43.144.26</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CLIENT_NAME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">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.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CPU_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DB_BLOCKS</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">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.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DB_CPU_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">DB_TOTAL_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and <span class="keyword parmname">DB_CPU_TIME</span>. Compare this field to <span class="keyword parmname">CPU_TIME</span> to determine whether performance issues are occurring in the database layer or in your own code.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ENTITY_NAME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Set</dd><dt class="dt dlterm">Description</dt><dd class="dd">The name of the object accessed by the API request.</dd><dd class="dd">For example: <samp class="codeph nolang">Account</samp>, <samp class="codeph nolang">Opportunity</samp>, <samp class="codeph nolang">Contact</samp>, and so on.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">EVENT_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="event-type-desc"><a name="event-type-desc"></a>The type of event.</span> The value is always <samp class="codeph nolang">API</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">EXCEPTION_MESSAGE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The exception message for a SOAP API request. An exception message gives details about errors in handling an API request, such as why an API request failed.</dd><dd class="dd">For example: <samp class="codeph nolang">common.exception.ApiException: startDate cannot be more than 30 days ago</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">LOGIN_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">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.</dd><dd class="dd">For example: <samp class="codeph nolang">GeJCsym5eyvtEK2I</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">METHOD_NAME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The name of the calling Apex method.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ORGANIZATION_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the organization.</dd><dd class="dd">For example: <samp class="codeph nolang">00D000000000123</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">QUERY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The data that was queried.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="request-id-desc"><a name="request-id-desc"></a>The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same <span class="keyword parmname">REQUEST_ID</span>.</span></dd><dd class="dd">For example: <samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_SIZE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="request-size-desc"><a name="request-size-desc"></a>The size of the callout request body, in bytes.</span></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">REQUEST_STATUS</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The status of the request for a page view or user interface action.</dd><dd class="dd">For example:<a name="ul_wgy_1rf_4q"></a><ul class="ul bulletList" id="ul_wgy_1rf_4q"><li class="li"><samp class="codeph nolang">S</samp>—Success. Salesforce handled the request successfully. If an Apex controller throws an exception, this status is also returned.</li><li class="li"><samp class="codeph nolang">F</samp>—Failure. Typically 4xx or 5xx HTTP codes, such as no permission to view page, page took too long to render, page is read-only.</li><li class="li"><samp class="codeph nolang">U</samp>—Undefined</li><li class="li"><samp class="codeph nolang">A</samp>—Authorization Error</li><li class="li"><samp class="codeph nolang">R</samp>—Redirect. Typically a 3xx HTTP code, possibly initiated by an Apex controller in a Visualforce page.</li><li class="li"><samp class="codeph nolang">N</samp>—Not Found. 404 error.</li></ul>This field can have a blank value.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">RESPONSE_SIZE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="response-size-desc"><a name="response-size-desc"></a>The size of the callout response, in bytes.</span></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">ROWS_PROCESSED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The number of rows that were processed in the request.</dd><dd class="dd">For example: <samp class="codeph nolang">150</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">RUN_TIME</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd"><span class="ph" id="run-time-desc"><a name="run-time-desc"></a>The amount of time that the request took in milliseconds.</span></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">SESSION_KEY</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">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.</dd><dd class="dd">For example: <samp class="codeph nolang">d7DEq/ANa7nNZZVD</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in GMT.</dd><dd class="dd">For example: <samp class="codeph nolang">20130715233322.670</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">TIMESTAMP_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">DateTime</dd><dt class="dt dlterm">Description</dt><dd class="dd">The access time of Salesforce services in ISO8601-compatible format (<samp class="codeph nolang">YYYY-MM-DDTHH:MM:SS.sssZ</samp>).</dd><dd class="dd">For example: <samp class="codeph nolang">2015-07-27T11:32:59.555Z</samp>. Timezone is GMT.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">URI</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The URI of the page that’s receiving the request.</dd><dd class="dd">For example: <span class="keyword parmname">/home/home.jsp</span>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">URI_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">ID</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the URI of the page that’s receiving the request.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 15-character ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd">For example: <samp class="codeph nolang">00530000009M943</samp></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_ID_DERIVED</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Id</dd><dt class="dt dlterm">Description</dt><dd class="dd">The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.</dd><dd class="dd"><span class="ph" id="user-id-derived-ex"><a name="user-id-derived-ex"></a>For example: <samp class="codeph nolang">00590000000I1SNIA0</samp></span>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">USER_TYPE</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">String</dd><dt class="dt dlterm">Description</dt><dd class="dd">The category of user license.</dd><dd class="dd">Possible values are:<a name="user-type-values"></a><ul class="ul bulletList" id="user-type-values"><li class="li"><samp class="codeph nolang">CsnOnly</samp>—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users.</li><li class="li"><samp class="codeph nolang">CspLitePortal</samp>—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.</li><li class="li"><samp class="codeph nolang">CustomerSuccess</samp>—Customer Success license. Users whose access is limited because they’re organization customers and access the application through a customer portal.</li><li class="li"><samp class="codeph nolang">Guest</samp>—Users whose access is limited so that your customers can view and interact with your site without logging in.</li><li class="li"><samp class="codeph nolang">PowerCustomerSuccess</samp>—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.</li><li class="li"><samp class="codeph nolang">PowerPartner</samp>—Power Partner license. Users whose access is limited because they’re partners and typically access the application through a partner portal or site.</li><li class="li"><samp class="codeph nolang">SelfService</samp>—Users whose access is limited because they’re organization customers and access the application through a self-service portal.</li><li class="li"><samp class="codeph nolang">Standard</samp>—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org.</li></ul></dd></dl></td></tr></tbody></table>

#### See Also

- [EventLogFile Supported Event Types](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_supportedeventtypes.htm "The EventType field in the EventLogFile object supports these events. 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. Sometimes, three quotation marks appear around event data containing special characters in the CSV file. The third quotation mark is necessary for tools and applications to parse the field data at the correct field value boundary.")
- [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm "Represents event log files generated by Event Monitoring. Use event log file data to analyze usage trends and user behavior in your Salesforce org. This object is available in API version 32.0 and later. The Interval and Sequence fields are available only in API version 37.0 and later.")