API Call Usage

This page explains IMan's usage of the Salesforce API allotted calls.

Meta Data Queries

A single API call will be consumed when IMan queries Salesforce for an object's metadata. When working in the designer there will be multiple calls to Salesforce to describe various objects. These calls may consume anywhere between 5-30 API calls. Typically, the results of these calls are cached for performance, so that once an object is described it will not be requested again during that session.

There are other instances where additional calls for metadata may be made.

Lookups

Each Lookup will consume a single API call.

Reader (Pull)

A single API call will be consumed each time an IMan executes containing a Salesforce Reader. Each subsequent 'page' of results returned by the query consumes another API call.

Connector (Push)

The number of API calls consumed by the Push connector is dependent on the underlying strategy the connector uses to write data to Salesforce.

Irrespective of the strategy each request consisting of 1 or multiple records will consume a single API call.

The strategies are described by on the following pages:

Examples

  • There are 500 records and the Tree API is used. This will mean 3 API calls where the first and second requests have 200 records and the third request 100.
  • There are 80 records and the Composite API is used, this will be a total of 4 API calls where the first three process 25 records and the last 10.
  • There are 16 hierarchical records where the 16 each have a varying numer of child records, each parent record is processed individually, so this would consume 16 API calls.

Salesforce API Usage

This can be viewed by logging to Salesforce, going Setup, typing System Overview in the Search box.

It is important to note the API Usage is a total cost for all applications used on the instance - not just IMan.