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.

Bulk API Request Event Type

The Bulk API request event captures when Bulk API requests are received to create a job, update a job, create a batch, update a batch, and when a job completes.

This event type doesn’t include Bulk API 2.0 requests. For information about the BulkApi2 event types, see Bulk API 2.0 Event Type.

Note

For details about event monitoring, see the Trailhead Event Monitoring module or REST API Developer’s Guide.

Fields

Field	Details
API_VERSION	Type Number Description The API version.
BATCH_ID	Type String Description The 15-character ID of the Bulk API batch.
CLIENT_IP	Type String 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`.
CLIENT_NAME	Type EscapedString Description The name of the client making the request.
CONCURRENCY_MODE	Type String Description The concurrency mode selected by the user.
CONNECTED_APP_ID	Type String Description The ID of the connected app making a request.
CPU_TIME	Type Number 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.
ERROR_MESSAGE	Type EscapedString Description The type of entity that the Bulk API used.
EVENT_TYPE	Type String Description The type of event. The value is always BulkApiRequest.
JOB_ID	Type String Description The 15-character ID of the Bulk API job.
LOGIN_KEY	Type String 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`.
OPERATION_TYPE	Type String Description The type of Bulk API operation.
ORGANIZATION_ID	Type Id Description The 15-character ID of the organization. For example: `00D000000000123`.
REQUEST_ID	Type String 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 REQUEST_ID. For example: `3nWgxWbDKWWDIk0FKfF5DV`.
REQUEST_PATH	Type String Description The path of the request.
RUN_TIME	Type Number Description The amount of time that the request took in milliseconds.
SESSION_KEY	Type String 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`.
STATUS_CODE	Type Number Description The HTTP Status code indicating whether the batch was successful.
SUCCESS	Type Boolean Description Whether the batch was successful.
TIMESTAMP	Type String Description The access time of Salesforce services in GMT. For example: `20130715233322.670`.
TIMESTAMP_DERIVED	Type DateTime Description The access time of Salesforce services in ISO8601-compatible format (`YYYY-MM-DDTHH:MM:SS.sssZ`). For example: `2015-07-27T11:32:59.555Z`. The timezone is GMT.
URI	Type String Description The URI of the page that’s receiving the request. For example: /home/home.jsp.
URI_ID_DERIVED	Type Id Description The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID	Type Id Description The ID of the user making the request.
USER_ID_DERIVED	Type Id Description The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API. For example: `00590000000I1SNIA0`.

Object Reference for the Salesforce Platform

Bulk API Request Event Type

Fields