SearchUnify API Limits
SearchUnify relies on API usage limits to provide reliable, secure, and fast services to its clients.
Limits
To maintain optimum performance and ensure that the SearchUnify platform API is available to all our customers, SearchUnify balances transaction loads by imposing two types of limits:
1. Concurrent API request limits
2. Total API request allocations
To ensure optimal system performance in the SearchUnify index, effective document size is set at 10 MB.
Concurrent API Requests
Concurrent API defines how many calls an instance can make simultaneously or in a second. The following table lists the limits for various types of tiers for concurrent requests within one second:
Tier Type |
Limits per second |
Definition |
Standard Tier |
5 |
The client can hit a maximum of 5 concurrent requests in a second
|
Total API Requests
Total API requests define how many calls an instance can make within an hour or longer period. The following table lists the limits for the total API requests per minute, hour, day, and month:
Search API
Search API is used to get the search results.
Limit |
Default value |
Definition |
Searches per minute |
60 |
Maximum 60 searches are allowed in a minute. |
Searches per hour |
3500 |
Maximum 3500 searches are allowed in an hour. |
Searches per day |
30000 |
Maximum 30000 searches are allowed in a day. |
Searches per month |
300000 |
Maximum 300000 searches are allowed in a month. |
Analytics API
Analytics API is used to get the analytics insights and reports.
Limit |
Default value |
Definition |
Searches per minute |
50 |
Maximum 50 requests are allowed in a minute. |
Searches per hour |
2500 |
Maximum 2500 requests are allowed in an hour. |
Searches per day |
15000 |
Maximum 15000 requests are allowed in a day. |
Searches per month |
150000 |
Maximum 150000 requests are allowed in a month. |
Content API
Content API is used to access or store the data within SearchUnify.
Limit |
Default value |
Definition |
Content Sources |
30 |
Add up to 30 content sources. |
Documents |
500000/day |
New documents that can be pushed to an existing content source in a day. The maximum index size for a standard license user is 40 GB. |
Bulk Upload |
200 |
New documents that can be pushed to the index simultaneously. |
Monitor Usage
You can monitor your API usage on the admin panel, as the API Logs help admins stay on top of API consumption. With date range and select OAuth API type filers, admins can find out the cumulative API calls made during a period and the calls made for a particular API during a period. For more information, check out View API Logs.
Limit Exceed
If your account reaches or exceeds its total API request limit, SearchUnify still allows the operations to proceed with degraded performance. This allows seamless workflows during unexpected spikes in workloads and occasional peak periods. A hard cap has been implemented to protect platform resources and prevent API requests from continually exceeding the daily limit.
The ability to go over your normal daily limit is always subject to restrictions for protecting the overall health of the SearchUnify instance. You can monitor the health of your instance on the SearchUnify admin panel.
Increase Allocations
The computation of API request volumes based on user licenses is meant to ensure that your account has enough capacity for the number of requests you make. If you need a higher amount you can purchase extra API calls. For information, contact your account representative.
Perform diligent research on your API use before purchasing more API calls. You may optimize a client application to use fewer API calls while still accomplishing the same task, whether it's your own business application or a partner application. If you're using a partner product, check with the vendor to see if it makes the best use of the API. Your company can suffer additional expenditures as a result of a product that makes inefficient API use.
Addon Package Costs
SearchUnify provides some additional add-on packages (Available on Demand) if your request consumption is higher than the standard
Tier |
API Count |
Definition |
Cost (USD) |
OOB |
300,000 |
300,000 API calls are available in OOB. |
OOB |
Pack 1 |
600,000 |
Add an additional 300,000 requests per month. |
Contact the SU team. |
Pack 2 |
900,000 |
Add an additional 300,000 requests per month. |
Contact the SU team. |
Pack 3 |
1,200,000 |
Add an additional 300,000 requests per month. |
Contact the SU team. |
Billed annually. Higher API calls are available on demand.
What Counts As A Call?
A call is initiated if you're using an OAuth app designed in your SearchUnify instance to consume analytics, content, and/or search API. Any activity on a search client doesn’t exhaust the API quota.
Error Codes
SearchUnify does not return an error when a call exceeds the request limit but you will find some delay in the responses.
Please sign in to leave a comment.
Comments
0 comments