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.

Composite API Event Type

Composite API events contain details about composite API requests. One composite API event is generated for each composite API and composite graph API call. This event type is available in API version 64.0 and later.

Fields

Field	Details
ALL_OR_NONE	Type boolean Description Indicates whether the entire request is rolled back when the update of any object fails (true), or if the call should continue with the independent update of other objects in the request (false). The default is false. If true, it overrides the ALL_OR_NONE setting in subrequests.
CLIENT_IP	Type String Description The IP address of the client that’s using the API.
CPU_TIME	Type Number Description The CPU time in milliseconds to complete the request.
EVENT_TYPE	Type String Description The type of the event. The value is always CompositeApi.
FAILURE_REASON	Type String Description An error code giving the reason for a failed request.
IS_REQUEST_COLLATION_ON	Type boolean Description The setting for subrequest collation.
LOGIN_KEY	Type String Description Identifies all related 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`
NUM_GRAPH_DEPTH	Type Number Description The depth of the graph. When multiple graphs are present, this number is the depth of the deepest graph.
NUM_RETRIES	Type Number Description Number of attempted retries while processing the graph.
ORGANIZATION_ID	Type Id Description The 15-character ID of the organization that made the request. For example: `00D000000000123`
REQUEST_ID	Type String Description A unique ID identifying the composite API request.
RUN_TIME	Type Number Description The amount of time in milliseconds to complete the request.
SESSION_KEY	Type String Description The user’s unique session ID. You can use this value to identify all user events within a session. For example: `20130715233322.670`
TIMESTAMP	Type String Description The date and time that the event was generated.
TIMESTAMP_DERIVED	Type DateTime Description The date and time, in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ), that the event was generated. The timezone is GMT. For example: `2015-07-27T11:32:59.555Z`
URI	Type String Description The resource URI.
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 15-character ID of the user that’s using the API. For example: `00530000009M943`
USER_ID_DERIVED	Type Id Description The 18-character case insensitive ID of the user that’s using the API. For example: `00590000000I1SNIA0`

Object Reference for the Salesforce Platform

Composite API Event Type

Fields

See Also