---
schema_version: "1"
id: 921e4d34e1d2592fe43b1f7bf6e33d70087653544b3976684055149d02190344
title: API Total Usage
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_eventlogfile_apitotalusage.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apitotalusage.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: e9d515415ab95cb68912049d8240d8c6dc371d53380f0215a88f286039021d8a
description: API Total usage events contain details about Platform SOAP API, Platform REST API, and Bulk API requests.
---
# API Total Usage

API Total usage events contain details about Platform SOAP API, Platform REST API, and Bulk API requests.

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">API_CLIENT_CATEGORY</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 the client making the API request.</dd><dd class="dd">Possible values are:<ul class="ul bulletList"><li class="li"><samp class="codeph nolang">AGENTFORCE_AGENT</samp>—API request is from an Agentforce agent.</li><li class="li"><samp class="codeph nolang">EXTERNAL_APPLICATION</samp>—API request is from an external app defined in the org.</li><li class="li"><samp class="codeph nolang">LIGHTNING_UI</samp>—API request is from the Lightning UI.</li><li class="li"><samp class="codeph nolang">SALESFORCE</samp>—API request is from an internal Salesforce app or service.</li><li class="li"><samp class="codeph nolang">UNKNOWN</samp>—API request is from an unrecognized category.</li><li class="li"><samp class="codeph nolang">SALESFORCE_HOSTED_MCP</samp>—API request is from a Salesforce Hosted MCP Server.</li></ul></dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">API_FAMILY</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 API family. Possible values are <samp class="codeph nolang">REST</samp>, <samp class="codeph nolang">SOAP</samp>, <samp class="codeph nolang">Bulk</samp>, <samp class="codeph nolang">ApexREST</samp>, <samp class="codeph nolang">DirectApexREST</samp> or <samp class="codeph nolang">DirectAura</samp>. <samp class="codeph nolang">ApexREST</samp> indicates an Apex REST call. <samp class="codeph nolang">DirectApexREST</samp> indicates an Apex REST Agent Action call. <samp class="codeph nolang">DirectAura</samp> indicates an AuraEnabled Apex Agent Action call.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">API_RESOURCE</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 API method or resource. For example, <samp class="codeph nolang">describeSObjects</samp> for SOAP, or <samp class="codeph nolang">/v21.0/sobjects/Account/001xx000003DGQW</samp> for REST.</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">Number</dd><dt class="dt dlterm">Description</dt><dd class="dd">The API version. For example, <samp class="codeph nolang">21.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 making the API request. Includes values passed via the Sforce-Call-Options header.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CONNECTED_APP_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">The ID of the connected app making the API request.</dd><dd class="dd">If the connected app ID includes the prefix <var class="keyword varname">0H4</var>, append it to the connected app ID in the My Domain URL to access app details (<samp class="codeph nolang">https://<var class="keyword varname">MyDomainName</var>.my.salesforce.com/<var class="keyword varname">0H4</var>xxxxxxxxxxxx</samp>). If, however, the connected app ID uses the prefix <var class="keyword varname">888</var>, contact Salesforce Customer Support for app details.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">CONNECTED_APP_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 connected app making the API request.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">COUNTS_AGAINST_API_LIMIT</span></td><td class="entry"><dl class="dl detailList"><dt class="dt dlterm">Type</dt><dd class="dd">Boolean</dd><dt class="dt dlterm">Description</dt><dd class="dd">Whether the request counted against the API limit (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</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">The type of event. The value is always <samp class="codeph nolang">ApiTotalUsage</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">HTTP_METHOD</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 HTTP method. For example, <samp class="codeph nolang">GET</samp>.</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">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">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>.</dd><dd class="dd">For example: <samp class="codeph nolang">3nWgxWbDKWWDIk0FKfF5DV</samp>.</dd></dl></td></tr><tr><td class="entry"><span class="keyword parmname">STATUS_CODE</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 HTTP response status code for the request.</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"><span class="ph" id="timestamp-ex"><a name="timestamp-ex"></a>For example: <samp class="codeph nolang">20130715233322.670</samp>.</span></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">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 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_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 username of the user who's using Salesforce services through the API.</dd></dl></td></tr></tbody></table>