API calls best practices
Some of the best practices that you can follow to use APIs effectively
- Fetch data based on your configured polling frequency. For example, if you want to fetch the log reports for a monitor with a polling frequency of 5 minutes, use /reports/log_reports/(\d+) at an interval of 5 minutes only to view any changes.
- If you wish to get the status of more than a single monitor, use /current_status to fetch data for your entire account, /current_status/group/(\d+) for a monitor group, or /current_status/type/(\S+) for a monitor type, instead of /current_status/(\d+) for a single monitor.
- Call the API /monitors (for an entire account) or /monitors/(\d+) (for a single monitor) only when you have made any configuration changes to your monitors. In case there are no changes made, it is recommended to cache the data at your end.
- For the availability/performance reports, use /reports/availability_summary/group/(\d+) or /reports/performance/group/(\d+) to fetch the reports for an entire monitor group, instead of making an API call for every monitor /reports/availability_summary/(\d+) or /reports/performance/(\d+).Also, you can use the light-weight basic availability APIs for a leaner reporting experience, simpler and faster data fetching.
- For fetching the performance reports of monitor groups, it is recommended to call the API on a hourly basis, as the data archiving is done only once in 60 minutes.
Follow our community post for instant updates on this topic.
Note: You cannot make any API calls for free accounts. You have to use either the Site24x7 web client or the Site24x7 mobile app.
API calls for a Business Unit account is applied at the account level in Site24x7. Learn more.
Related article
Related Articles
How many API calls does Site24x7 GCP monitor make
Site24x7 Google Cloud monitoring (GCP) fetches the health and performance metrics and your Google Cloud resources' data via APIs. Here is an illustrative calculation on how many API calls will be made by Site24x7 for monitoring your Google Cloud ...How many API calls does Site24x7 Azure monitor make
Site24x7 Azure monitoring uses APIs to retrieve the health and performance metrics, as well as the configuration data on your Azure resources. Microsoft charges based on the total number of API calls made. Therefore, the cost incurred is directly ...Is there a restriction on the number of API calls allowed per day?
We do have a restriction on the number of API calls allowed per day. You can make 200 API calls/day for every basic and advanced monitor; 40 API calls/day for every network interface in your license. This is exclusive of the API calls made from the ...API exceeded error
Why do I get an API exceeded error after a few attempts? Every API has a certain limit to the number of requests a user can hit within a period of time, called the rate limit. An error message is triggered when a user does one of the following ...How to download the saved search data using API
Use the below API to download saved search data in CSV or JSON format: https://www.site24x7.com/api/applog/saved_searches/download/<search_id>/<from_date>/<to_date>?data_format=json&range=1-100&order=desc The following are the field values passed to ...