Articles in this section

Track your API usage

Kathyana Queeman
Updated

Your integrator.io subscription allows a set number of API calls per month. This article explains which invocations count as an API call, which don't, how to read the API usage details on the Subscription page, and what happens when you exceed the entitlement. Go to Account avatar-icon.png, and then select Subscription to view your API usage.

What counts as an API call

Every invocation of a custom API or a standalone resource counts as one call, whether it's made directly or through API Management:

  • Direct calls – You call the integrator.io invoke URL with an API token, for example https://api.integrator.io/apis/v1/pet for an API or https://api.integrator.io/v1/exports/69••••121/invoke for a resource. Without API Management, all your calls are direct.
  • Fully managed calls – You call the API Management gateway URL, for example https://production-petstore.gateway.apim.integrator.io/pets. With API Management you can use either kind.

A call counts when it targets one of these:

  • A custom API built with API builder or JavaScript.
  • An API registered in the API Management console.
  • A standalone resource, such as a lookup, export, or import, or a virtual resource, invoked from outside the Celigo platform, for example from Postman. Virtual resources can't be pushed to the API Management console.

These don't count:

  • Calls to Celigo's standard APIs.
  • Connections invoked inside a flow or an API. Those count toward the connection's endpoint entitlement instead (see Track your endpoint usage).
  • JavaScript runtime (JSRT) functions.
  • APIs called by integration apps.

Examples

  • Calling an API – A Pets API built with API builder runs a DynamoDB lookup. Calling it directly (https://api.integrator.io/apis/v1/pet) or through the gateway (https://production-petstore.gateway.apim.integrator.io/pets) counts one API call. The DynamoDB lookup counts toward your DynamoDB endpoint, not as a second API call.
  • Calling a lookup on its own – Invoking the same DynamoDB lookup by its own URL (https://api.integrator.io/v1/exports/69••••121/invoke or https://production-petstore.gateway.apim.integrator.io/petsLookup) also counts one API call plus the DynamoDB endpoint.

Review your API usage

On the Subscription page, select View next to API calls invoked:

  • Current usage – Your calls this month by API. Filter by environment and by API type: API builder, JavaScript, or other resource. Filtering by environment switches you to that environment; switch back when you're done.
  • Historical usage – Your calls per month. This view isn't broken down by API or environment.

If you use API Management, the count is the sum of direct and fully managed calls for the month, and the APIM analytics console gives you per-API logging, dashboards, and notifications. To open it, hover over the help icon next to the usage and select the link. See Configure APIM analytics, logging, and notifications.

If you exceed your API entitlement

Caution: Your APIs keep working above the entitlement, but a rate limit is enforced on them. You're notified by email as you near, reach, and exceed the limit.