Compliance API Request Limits and Patterns
Note
This page is under construction. Please come back later!
API Request Limits and Call Patterns
To continually improve our Compliance API solution, we are currently evaluating all partners call patterns to see how to improve our API services. All Compliance partners will space out their archiving API requests evenly throughout each hour to not be rate limited by our developer platform.
Your application should NOT have API call patterns that have high queries per second (QPS) burst. In the coming months, we will start enforcing QPS throttle on your applications. For more information on your current application limits, please see the Usage & Limits section of your application.
Compliance Events API
Given that an application should query the Compliance Events API once per hour per member, the API request call pattern should be estimated by using the following formulas:
- Estimated Queries Per Second (QPS) - Calculated by total unique members over an hour.
- Estimated Seconds Between Each Request - Calculated by an hour over total unique members.
The following table provides an estimated reference:
| Unique Members | Maximum Requests Per Hour | Estimated QPS | Estimated Seconds Between Each Request |
|---|---|---|---|
| 1 - 1,000 | 1,500 | 0.25 QPS | 3 - 30 seconds |
| 1,001 - 5,000 | 7,500 | 1.5 QPS | 1 - 3 seconds |
| 5,001 - 10,000 | 15,000 | 3 QPS | 0.3 - 1 seconds |
| 10,001 - 20,000 | 30,000 | 6 QPS | 0.15 - 0.3 seconds |
| 20,001 - 30,000 | 45,000 | 10 QPS | 0.1 - 0.15 seconds |
| 30,001 - 50,000 | 75,000 | 15 QPS | 0.05 - 0.1 seconds |
| 50,001 - 100,000 | 150,000 | 30 QPS | 0.025 - 0.05 seconds |
| 100,000+ | TOTAL UNIQUE MEMBERS + 50% ADDITIONAL REQUESTS | TOTAL UNIQUE MEMBERS / 3600 | 3600 / TOTAL UNIQUE MEMBERS |
Snapshot APIs
Your application should primarily rely on the Compliance Events API except for:
- Onboarding a new member - retrieving a complete overview of the member's profile. This should be a one time request
per day. The following table provides an estimated reference:
| Unique Members | Maximum Requests Per Day | Estimated QPS | Estimated Seconds Between Each Request |
|---|---|---|---|
| 1 - 1,000 | 1,500 | 0.015 QPS | 60 - 90 seconds |
| 1,001 - 5,000 | 7,500 | 0.06 QPS | 15 - 60 seconds |
| 5,001 - 10,000 | 15,000 | 0.15 QPS | 8 - 15 seconds |
| 10,001 - 20,000 | 30,000 | 0.3 QPS | 4 - 8 seconds |
| 20,001 - 30,000 | 45,000 | 0.4 QPS | 2 - 4 seconds |
| 30,001 - 50,000 | 75,000 | 0.6 QPS | 1.5 - 2 seconds |
| 50,001 - 100,000 | 150,000 | 1.2 QPS | 0.8 - 1.5 seconds |
| 100,000+ | TOTAL UNIQUE MEMBERS + 50% ADDITIONAL REQUESTS | TOTAL UNIQUE MEMBERS / 86400 | 86400 / TOTAL UNIQUE MEMBERS |
- Content not available on Compliance Events API - retrieving the following content
every four hours. The following table provides an estimated reference:- Organization Content
- Group Content
- Email Address
| Unique Members | Maximum Requests Per Four Hours | Estimated QPS | Estimated Seconds Between Each Request |
|---|---|---|---|
| 1 - 1,000 | 1,500 | 0.06 QPS | 10 - 15 seconds |
| 1,001 - 5,000 | 7,500 | 0.4 QPS | 2 - 10 seconds |
| 5,001 - 10,000 | 15,000 | 0.8 QPS | 1 - 2 seconds |
| 10,001 - 20,000 | 30,000 | 1.5 QPS | 0.6 - 1 seconds |
| 20,001 - 30,000 | 45,000 | 2.5 QPS | 0.4 - 0.6 seconds |
| 30,001 - 50,000 | 75,000 | 4 QPS | 0.2 - 0.4 seconds |
| 50,001 - 100,000 | 150,000 | 8 QPS | 0.1- 0.2 seconds |
| 100,000+ | TOTAL UNIQUE MEMBERS + 50% ADDITIONAL REQUESTS | TOTAL UNIQUE MEMBERS / 14400 | 14400 / TOTAL UNIQUE MEMBERS |
High Usage APIs
APIs that have overlapping usage such as UGC Post and Social Actions will have additive throttle limits. Below are formulas to calculate:
| APIs | Throttle Formula for Maximum Requests Per Four Hours |
|---|---|
| UGC Post | Maximum Requests Per Four Hours * 2 (organization and group) * 10 (average number of entity per user) |
| Social Actions | Maximum Requests Per Four Hours * 2 (organization and group) * 10 (average number of entity per user) |
| Social Actions Comments | Maximum Requests Per Four Hours * 2 (organization and group) * 10 (average number of entity per user) * 10 (average number of posts per entity that more more comments than average |
| Social Actions Likes | Maximum Requests Per Four Hours * 2 (organization and group) * 10 (average number of entity per user) * 10 (average number of posts per entity that more more comments than average |