Workato measures API platform usage based on API calls.
API recipe usage calculations apply to both Managed APIs (API recipes) and API Gateway (API proxy and API proxy with transformation).
Usage calculation rules
API platform usage calculations follow the general usage calculations rules, where successful calls count towards usage and failed calls are excluded.
Workato uses the following additional rules to calculate API recipe usage:
- The recipe must execute completely without internal errors.
- The job must finish as designed, even if it returns expected errors such as 4xx or 5xx status codes defined in the recipe logic.
Usage counting
The total API recipe usage of a recipe job is one API call per successful execution. If an API recipe involves IDP (Intelligent Document Processing) or Event streams capabilities, Pages processed or Events processed is calculated in addition to API calls.
Example usage calculations
The following examples demonstrate how Workato calculates usage for API calls in different scenarios.
Managed API: API recipe
API call
API recipes contribute to usage as API calls. Each execution of an API recipe counts as one API call.
API recipes don't contribute to Business actions, even if the recipe contains steps that would otherwise be considered eligible.
However, if an API recipe contains an IDP or Event streams operation, the API recipe can also contribute to Pages or Events processed, in addition to the API call.
Usage totals
- API calls: 1
- Total usage per job: 1 API call
API Gateway: API proxy recipe
API Proxy recipe
API proxy recipes contribute to API calls, with each execution of the recipe counting as one API call.
API proxy recipes don't contribute to Business actions, even if the recipe contains steps that would otherwise be considered eligible.
However, if an API proxy recipe contains an IDP or Event streams operation, the API recipe can also contribute to Pages or Events processed, in addition to the API call.
API proxy calls are calculated at a lower call to credit ratio than managed API calls.
Usage totals
Total usage per job:
- API calls: 1
- Total usage per job: 1 API call
API Proxy recipe with transformation
API proxy recipes with transformation contribute to API calls, with each execution of the recipe counting as one API call.
API proxy recipes with transformation don't contribute to Business actions, even if the recipe contains steps that would otherwise be considered eligible.
However, if an API proxy recipe with transformation contains an IDP or Event streams action, the API recipe can also contribute to Pages or Events processed, in addition to the API call.
API proxy calls are calculated at a lower call to credit ratio than managed API calls.
Usage totals
Total usage per job:
- API calls: 1
- Total usage per job: 1 API call