Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ApiTotalUsageEventLog

API Total Usage Event Log contains details about Platform SOAP API, Platform REST API, and Bulk API requests. This object is available in API version 61.0 and later.

This object stores event data that's queryable from platform APIs. For event data stored in event log files, see EventLogFile.

Note

Supported Calls

describeSObjects(), query()

Special Access Rules

To access this object, you must have the View Event Log Object Data user permission.

Fields

Field	Details
ApiFamily	Type string Properties Filter, Group, Nillable, Sort Description The API family. For example, REST, SOAP, or Bulk.
ApiResource	Type string Properties Filter, Group, Nillable, Sort Description The API method or resource. For example, `describeSObjects` for SOAP.
ClientIp	Type string Properties Filter, Group, Nillable, Sort Description 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”. For example: 96.43.144.26.
ClientName	Type string Properties Filter, Group, Nillable, Sort Description The name of the client making the API request.
ConnectedAppIdentifier	Type string Properties Filter, Group, Nillable, Sort Description The ID of the connected app making the API request.
HttpMethod	Type string Properties Filter, Group, Nillable, Sort Description The HTTP method. For example, `GET`.
IsApiLimitCounted	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Whether the request counted against the API limit (`true`) or not (`false`). The default value is `false`.
IsExternalApplicationSoapApiLogin	Type boolean Properties Defaulted on create, Filter, Group, Sort Description The default value is `false`.
ObjectName	Type string Properties Filter, Group, Nillable, Sort Description The name of the object accessed by the API request.
RequestIdentifier	Type string Properties Filter, Group, Nillable, Sort 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 `RequestIdentifier.` For example: 3nWgxWbDKWWDIk0FKfF5DV.
StatusCode	Type int Properties Filter, Group, Nillable, Sort Description The HTTP response status code for the request.
Timestamp	Type dateTime Properties Filter, Nillable, Sort Description The access time of Salesforce services in GMT. For example, `2020-01-20T19:12:26.965Z`. Milliseconds are the most granular setting.
UserIdentifier	Type string Properties Filter, Group, Nillable, Sort Description The ID of the user who’s using Salesforce services through the UI or the API. For example: `00530000009M943`.

Object Reference for the Salesforce Platform

ApiTotalUsageEventLog

Supported Calls

Special Access Rules

Fields