How SaaS Manager executes REST API calls and calculates API volume after integration setup
After establishing a connection between SaaS Manager and any third-party application such as Box or ServiceNow, REST API calls are made to retrieve data from the vendor. This article details how often these calls occur, what determines their frequency, and includes an example calculation of API volume for Box Client Credentials integration.
For any integration in SaaS Manager, the endpoints used to pull information from the vendor are executed based on the integration task schedule
- When an integration task runs, SaaS Manager calls the vendor’s REST APIs during that scheduled window.
- The next API call occurs during the next scheduled run of the integration task.
- Example: If the task runs daily at 9:00 AM, the APIs execute once every 24 hours.
IMPORTANT: If multiple tasks are scheduled at different times, API calls occur according to each task’s schedule regardless of vendor.
Example: Box Client Credentials integration
App Roster
- Total users: 15,000
- Each REST API call retrieves 1,000 users
- One App Roster run requires 15 API calls
- Task executes once every 24 hours
- Monthly calls: 15 × 30 = 450
App Access
- Each REST API call captures 500 user events
- Daily events: 3,000
- Initial run for last 30 days:
- 90,000 events ÷ 500 = 180 API calls
- Subsequent runs:
- 3,000 events ÷ 500 = 6 API calls per day
- Monthly calls: 6 × 30 = 180
Combined API calls
- App Roster: 450 calls/month
- App Access: 180 calls/month
- Total: 630 REST API calls/month for Box Client Credentials integration
NOTE: API volume varies by integration based on total number of users, number of events, and pagination limits for each API.
Additional information
Once the integration is established, API calls occur automatically based on the configured task schedule.
- This ensures data is refreshed at regular intervals without manual intervention.
- For planning purposes, understanding API volume helps estimate load and optimize performance.
