Object Reference for Salesforce and Force.com

Object Basics
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

External OData Callout Event Type

External OData Callout events represent external data callouts via the OData 2.0 and OData 4.0 adapters for Salesforce Connect. This event type is available in the EventLogFile object in API version 40.0 and later.

For details about querying EventLogFile and learning more about event monitoring, see the Force.com REST API Developer Guide.

We provide Salesforce Connect Callout Event Monitoring to customers through a public pilot program. The pilot event types are available in orgs that use Salesforce Connect and Event Monitoring. If your org doesn't have these features, contact your Salesforce account executive to participate in the pilot. Salesforce Connect Callout Event Monitoring is subject to change and isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. 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. You can provide feedback and suggestions for Salesforce Connect Callout Event Monitoring in the Salesforce Connect group in the Success Community.

Note

Fields

Field Details
ACTION
Type
String
Description
Action performed by the callout.
Possible Values
  • query
  • upsert
  • delete
BYTES
Type
Number
Description
Size of the result set in bytes.
ENTITY
Type
String
Description
Name of the external object being accessed.
Example
Order
EVENT_TYPE
Type
String
Description
Type of event. Value is always ExternalODataCallout.
EXECUTE_MS
Type
Number
Description
Reserved for future use.
EXPAND
Type
String
Description
Reserved for future use.
FETCH_MS
Type
Number
Description
Reserved for future use.
FILTER
Type
Text
Description
Field expressions to filter which rows to return. Corresponds to WHERE in SOQL queries and $filter in OData queries.
Example
CustomerID eq 12345
LIBRARY
Type
String
Description
Reserved for future use.
LIMIT
Type
Number
Description
Maximum number of rows to return for a query. Corresponds to LIMIT in SOQL queries and $top in OData queries.
Example
200
MESSAGE
Type
String
Description
Error or warning message associated with the failed call.
Example
The OData query result was too large, so the external data didn’t load.
OFFSET
Type
Number
Description
Number of rows to skip when paging through a result set.

Corresponds to OFFSET in SOQL queries and $skip in OData queries.

Example
10
ORDERBY
Type
String
Description
Field or column to use for sorting query results, and whether to sort the results in ascending (default) or descending order. Corresponds to ORDER BY in SOQL queries and $orderby in OData queries.
Examples
  • ShipName
  • ShipName desc
ORGANIZATION_ID
Type
Id
Description
15-character ID of the organization.
Example
00D000000000123
PROVIDER_TYPE
Type
String
Description
Whether the OData 2.0 or OData 4.0 adapter made the callout.
Possible Values
  • OData—OData 2.0 adapter
  • OData4—OData 4.0 adapter
RATE_LIMIT_USAGE_PERCENT
Type
Number
Description
Consumed percentage of the org’s limit of OData callouts per hour.
Example
2.5—2.5% of the hourly callout limit has been consumed
REQUEST_ID
Type
String
Description
Unique ID of a transaction. A transaction can contain one or more events. All events in a transaction have the same REQUEST_ID.
Example
4A13-HSKv3CKs-0FKfceaV
REQUESTS
Type
Number
Description
Reserved for future use.
ROWS
Type
Number
Description
Reserved for future use.
SEARCH
Type
String
Description
Search query string. Corresponds to condition expressions in SOSL.
Example
contains(CustomerID,'10248') eq true or contains(ShipName,'10248') eq true
SELECT
Type
String
Description
Comma-separated list of fields being queried. Corresponds to SELECT in SOQL queries and $select in OData queries.
Example
CustomerID,OrderDate,OrderID,ShipCity,ShipCountry
STATUS
Type
Boolean
Description
Whether the query was successful.
Possible Values
  • 1—Success
  • 0—Failed
THROUGHPUT
Type
Number
Description
Reserved for future use.
TIMESTAMP
Type
String
Description
When the event occurred.
Example
20150101000000.000
TIMESTAMP_DERIVED
Type
DateTime
Description
When the event occurred in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
Example
2015-07-27T11:32:59.555Z
TOTAL_MS
Type
Number
Description
How long it took (in milliseconds) to prepare and execute the query and to retrieve the query results.
USER_ID
Type
Id
Description
15-character ID of the user accessing the external system.
Example
00530000009M943