Limits and allowances
Your plan sets how much you can do through the API, and each signed-in person has a number of requests a minute.
Requests per minute
Requests are counted for each signed-in person over a fixed window of 60 seconds that refills all at once. Over the limit, the answer is 429 with errorCode RequestBlocked and a Retry-After header.
| Requests | Counted for | Limit |
|---|---|---|
| Calls that read | Each signed-in person | 300 |
| Calls that start work | Each signed-in person | 30 |
| Asking about an operation | Each signed-in person | 500 |
| Calls that start work | Everyone in the account together | 60 |
| Add Pixies and Remove Pixies, a call over many reports counting as one | Everyone in the account together | 10 |
Each route's reference names the requests it counts against.
Plan allowances
The API spends the same allowances as the BI Pixie portal. What the plan allows and what has been used. used is null when it could not be read. limit is null when the plan sets no limit. To read yours before you spend them, use Get the account.
| Allowance | Type | Description |
|---|---|---|
trackedItems | Allowance | |
assessments | PeriodAllowance | |
optimizationApplies | PeriodAllowance | |
benchmarkRuns | PeriodAllowance | |
firstLooks | Allowance | |
scheduledAssessments | boolean | Whether the plan includes assessments that run on a schedule. |