Rate limiting
When your app makes a call to the Web SDK, the call consumes resources.
Consumption is calculated in credits, and it depends on the type of operation, as well as on the type of board item that is the target of the request.
For example:
- Drag and drop events don't use any credits.
Cost: 0 credits - Most calls use 50 credits per call.
- Time-consuming operations such as creating or updating images and embed items are computationally more expensive than getting a sticky note; therefore, they consume more credits.
Cost: 500 credits per call
Within the enforced rate limits, it's possible to perform bulk actions (creating, updating or deleting multiple items at once).
Web SDK methods fall in one of the following rate limit weight levels:
| Weight | Cost of one Web SDK API call | Action |
|---|---|---|
| Level 1 | 50 credits | Most actions on board items. |
| Level 2 | 100 credits | N/A |
| Level 3 | 500 credits | Create or update an image or an embed item. |
| Level 4 | 2000 credits | N/A |
Current rate limits for the Miro Web SDK:
| Limit | Credits | Note |
|---|---|---|
| Max. credits per minute | 100,000 | It supports:
|
| Max. credits per hour | 1,000,000 | It supports:
|
If your app exceeds either limit, it receives an error.
If your app exceeds a limit, it needs to wait for new credits before making calls to the Web SDK.
New credits are issued after the time interval when the limit was triggered has elapsed.
SDK APIs rate limits
Items methods rate limits
Note:
Itemrefers to most of supported item types on a board. See supported board items for more details.
| Method | Cost (credits per call) |
|---|---|
item.sync | 50 |
embed.sync | 500 |
image.sync | 500 |
item.goToLink | 50 |
item.getMetadata | 50 |
item.setMetadata | 50 |
item.bringToFront | 50 |
item.sendToBack | 50 |
item.bringInFrontOf | 50 |
item.sendBehindOf | 50 |
item.getConnectors | 500 |
mindmapNode.getChildren | 500 |
image.getFile | 50 |
image.getDataUrl | 50 |
group.ungroup | 50 |
group.getItems | 50 |
Updated 4 months ago