API Query Parameters
Our API is built to help you access your organizations data as easily as possible. We have incorporated pagination capabilities and the ability to pull multiple data entries at the same time to simplify your data management processes.
Parallelizing Requests to Increase Integration Speed
When setting up your API client, you can send up to 20 concurrent, asynchronous request calls at once. Inspectorio API Servers can support 20 workers at the same time. Parallelizing your API calls will improve the speed of your data integration significantly. For example:
Scenario A) One request at a time 3,600 requests * 2 seconds per request = 2 Hours
Scenario B) Parallelizing requests, 20 at a time 3,600 requests / 20 = 180 * 2 seconds per request = 6 Minutes
limit parameter to specify how many organizations you wish to pull in each request.
When requesting a large number of entities from our API, it is possible that the request may be interrupted or truncated resulting in an inadequate transfer of information. In order to avoid such an incident, we provide pagination capabilities that allow you to break up large requests to our API into multiple smaller requests. Use this technique to access specific organizations profiles, make more reliable requests to our API and simplify your organizations data management.
You wish to access 1000 organizations from our API. Instead of making one large request for all 1000 organizations, break that request up into ten 100 requests. Use the (
offset) parameter to keep track of which specific organizations you are accessing. For example, in order to access the first 100 profiles, use (
offset=0) and (
limit=100). Then, to access the second 100 profiles, use (
offset=100) and (
limit=100), this request will provide 100 organizations starting with organization #101 and ending on #200.