After creating an API, you can track your API usage (calls) and request add-on entitlements if you're running low. An API call counts when a resource or custom API endpoint is invoked either directly through integrator.io or via the API Management console. The second criterion for counting an API call is based on the resource type.
If you're taking advantage of API Management (APIM), you can access additional monitoring through the APIM console, like logging, dashboards, and notifications.
Warning
To protect your business processes, the Celigo platform will not prevent you from invoking your APIs if you exceed your API call entitlement. However, a rate limit will be enforced. You will receive email notifications when you are nearing, at, and over your limit.
To learn more about managing flow and connection entitlements, see Know your flow entitlements and How much capacity does my account have?.
Production/Sandbox API usage
An API call counts when a resource or custom API endpoint is invoked either directly through integrator.io or via the API Management console. Every invocation counts as one (1) call. There are two types of calls:
-
A direct call counts when you trigger the Celigo invoke URL and a token.
-
Invoke an API:
https://api.integrator.io/apis/v1/pet -
Invoke a resource:
https://api.integrator.io/v1/:_resourceType/:_resourceId/invoke
-
-
Fully managed calls are triggered using the APIM gateway URL.
-
Invoke an API or resource pushed to the APIM console:
https://production-petstore.gateway.apim.integrator.io/pets
-
In summary, direct calls do not use API Management, but fully managed calls do. If you don't have API Management, you can only make direct calls. If you do, you can use either a direct call or a fully managed call.
The second criterion for counting an API call is based on the resource type. Invoking any of the following counts towards your usage:
-
Invoking APIs built using API Builder or JavaScript
-
Invoking standalone resources (like a lookup, export, or import) or a virtual resource from outside the Celigo platform (ex. Postman or other third-party app)
-
Invoke a resource using the integrator.io invoke URL and token:
https://api.integrator.io/v1/exports/69••••121/invoke -
Invoke a standalone resource using the APIM gateway URL:
https://production-petstore.gateway.apim.integrator.io/petsLookupNote
Virtual resources cannot be pushed to the APIM console.
-
-
Invoking APIs registered in the APIM console
Invoking any of the following does not count towards your API usage:
-
Invoking Celigo's standard APIs
-
Invoking any connections to an application in a flow or API
Note
Invoking a connection to an application counts towards your connection's entitlements, not an API call.
-
JSRT functions
-
Integration app APIs
Let's say that you use API builder to create a Pets API. The API triggers a DynamoDB lookup to retrieve pets from a database. You can invoke the Pets API either through integrator.io's invoke URL or through the APIM console.
Invoking the Pets API endpoint counts as one call and uses one connection entitlement.
-
Direct call:
https://api.integrator.io/apis/v1/pet– OR –
Fully managed call:
https://production-petstore.gateway.apim.integrator.io/pets -
Connection usage: The DynamoDB lookup triggered by the Pets API counts towards your DynamoDB connection entitlements, not a separate API call.
Let's say that you want to trigger a DynamoDB lookup to retrieve pets from a database. Instead of invoking the Pets API, you can use the lookup's invoke URL to trigger it independently.
Invoking the standalone DynamoDB lookup counts as one call and uses one connection entitlement.
-
Direct call:
https://api.integrator.io/v1/exports/69••••121/invoke– OR –
Fully managed call:
https://production-petstore.gateway.apim.integrator.io/petsLookup -
Connection usage: The DynamoDB lookup triggered by the
PetsAPI counts towards your DynamoDB connection entitlements, not a separate API call.
To review your API entitlements and usage:
-
Navigate to → .
-
In the Entitlement usage section, review your API calls.
-
Click View for a current, in-depth view of your usage per API or a historical view of your previous months' use.
-
Current usage: A table summary of your usage by API.
You can filter by environment and API type (API builder, JavaScript, or other resource). If you use the environment filter, Celigo automatically switches to the selected environment. Remember to switch back to your desired environment after tracking your usage.
-
Historical usage: A per-month summary of your usage. Note that it doesn't break down usage by API or environment.
-
The way your usage is displayed depends on whether your account has a Production environment, a multi-environment entitlement, or an original Production/Sandbox entitlement.
As a rule, the usage bar summarizes your total call usage across all environments. For example, let's say you've used 60 call entitlements across production and sandbox. Even if the prod environment used 50 and the sandbox environment used 10, the bar will display the total across both environments (60) in all sections.
In a production-only environment, the usage is as depicted.
Production
In multi-environment accounts, click → → → or open the detailed view and filter by environment. If you use the filter, Celigo automatically switches to the selected environment. Remember to switch back to your desired environment after tracking your usage.
Production
In accounts with an original Production/Sandbox entitlement, the bar is duplicated (once for sandbox and once for production). The total number of calls used across all environments is shown, even though there are separate bars for production and sandbox.
Production/Sandbox account environment
If you're taking advantage of API Management, usage is determined by adding the number of direct and fully managed API calls for the current month. You can open the APIM analytics console by hovering over the help text icon (?) and clicking the link. Learn more about advanced analytics with API Management.