--- schema_version: "1" id: b42d85a60bf6156b579151638cc9458e8cf268ddd69df8b495aaf21fa8334413 title: ApexRestApiEventLog collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_apexrestapieventlog.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_apexrestapieventlog.htm source_site: developer.salesforce.com content_type: documentation content_hash: da69c61b7fe0fdb4c82a3fe78442bbd73b73f67bd2dca3de34afc06b60d47864 description: Apex REST API event logs capture information about every Apex REST API request. This object is available in API version 55.0 and later. --- # ApexRestApiEventLog Apex REST API event logs capture information about every Apex REST API request. This object is available in API version 55.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note This object stores event data that's queryable from platform APIs. For event data stored in event log files, see [EventLogFile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile.htm). ## 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 | | --- | --- | | 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. | | CpuTime | Type double Properties Filter, Nillable, Sort 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. | | DatabaseBlocks | Type double Properties Filter, Nillable, Sort 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. | | DatabaseCpuTime | Type double Properties Filter, Nillable, Sort Description The CPU time in milliseconds to complete the request. Indicates the amount of activity taking place in the database layer during the request. | | DatabaseTotalTime | Type double Properties Filter, Nillable, Sort Description The time in nanoseconds for a database round trip. Includes time spent in the JDBC driver, network to the database, and DatabaseCpuTime. Compare this field to CpuTime to determine whether performance issues are occurring in the database layer or in your own code. | | ExceptionMessage | Type string Properties Filter, Nillable, Sort Description 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. For example: common.exception.ApiException: startDate cannot be more than 30 days ago. | | FieldCount | Type int Properties Filter, Group, Nillable, Sort Description The number of fields or columns, where applicable. | | LoginKey | Type string Properties Filter, Group, Nillable, Sort 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. | | MediaType | Type string Properties Filter, Group, Nillable, Sort Description The media type of the response. | | Method | Type string Properties Filter, Group, Nillable, Sort Description The apex method name. | | ObjectName | Type string Properties Filter, Group, Nillable, Sort Description API objects that are accessed. For example: Account, Opportunity, Contact, and so on. | | 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 RequestId. For example: 3nWgxWbDKWWDIk0FKfF5DV. | | RequestSize | Type double Properties Filter, Nillable, Sort Description The size of the callout request body, in bytes. | | RequestStatus | Type string Properties Filter, Group, Nillable, Sort Description The status of the request for a page view or user interface action. For example: - 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. This field can have a blank value. | | ResponseSize | Type double Properties Filter, Nillable, Sort Description The size of the callout response, in bytes. | | RowsProcessed | Type int Properties Filter, Group, Nillable, Sort Description The number of rows that were processed in the request. For example: 150. | | RunTime | Type double Properties Filter, Nillable, Sort Description The amount of time the request took, as measured by SFDC code. | | SessionKey | Type string Properties Filter, Group, Nillable, Sort 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. | | StatusCode | Type int Properties Filter, Group, Nillable, Sort Description The HTTP status code for the response. | | 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. | | Uri | Type string Properties Filter, Group, Nillable, Sort Description The URI of the page that’s receiving the request. For example: /home/home.jsp. | | UserIdentifier | Type string Properties Filter, Group, Nillable, Sort Description The 15-character ID of the user who’s using Salesforce services through the UI or the API.For example: 00530000009M943. | | UserType | Type string Properties Filter, Group, Nillable, Sort 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. |