afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/RestApiEventLog.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules"
  ],
  "title": "RestApiEventLog - Data API",
  "description": "REST API event logs contain details about REST-specific requests. This object is available in API version 61.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "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 REST 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": "double",
      "properties": "Filter, 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 HTTP method of the request. For example: GET, POST, PUT, and so on."
    },
    "ObjectName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name of the object accessed by the API request. 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 RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV."
    },
    "RequestSize": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The size of the callout response, in bytes."
    },
    "RequestStatus": {
      "type": "String",
      "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": "Numbers of rows that are processed by the REST API."
    },
    "RunTime": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The amount of time that the request took in milliseconds."
    },
    "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 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."
    },
    "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."
    }
  },
  "special_access_rules": "To access this object, you must have the View Event Log Object Data user permission."
}