Rate & Size Limiting
Rate Limits
To ensure a consistent experience for all consumers of the Trackunit REST APIs, many APIs have rate limits, and a page size limit applies to collection endpoints.
Where an API's limits are published, they are listed in the Rate Limiting section of its introduction page. Other APIs can also return 429, so always handle it as described below. The Fair Use Policy applies to all APIs.
Trackunit might adjust the rate limits to balance our demand and reliability.
Requests that are rate limited will get an error with a HTTP response code 429 back.
How limits are counted
Each published limit is listed in a table on the API's page. Find the row for your endpoint and HTTP method: it lists every limit that applies to those requests. When a row has two limits, such as 2 per minute and 600 per minute, requests must stay within both.
The Scope column says what each allowance is counted for:
- Account: the Trackunit account the request is made in.
- API user: the API credentials making the request. Where a page says user, Trackunit users signed in to the apps are counted the same way as API users.
- HTTP method: when the scope includes it,
GETandPOSTon the same endpoint have separate allowances. - IDs in the path: when the scope includes an ID, each ID has its own allowance. For example,
/v2/assets/1and/v2/assets/2are counted separately. - Query parameters are not part of the scope unless the page says so. For example, on the access management API,
/keyusage?assetId=1and/keyusage?assetId=2share the 600 per minute allowance, while the 2 per minute limit is counted per asset.
When the scope says an allowance is shared, all the listed endpoints or methods count towards the same limit.
Retry-After header
A rate limited 429 response includes a Retry-After header with the number of seconds, as a whole number, to wait before retrying:
HTTP/1.1 429 Too Many Requests
Retry-After: 42
- Wait at least that many seconds before retrying. Retrying sooner is likely to be rate limited again.
- The value is an estimate. If other requests use up the limit in the meantime, the retry can still get a
429, so keep handling429with a backoff. - The value includes a small random delay, so clients that were limited at the same time don't all retry at the same moment.
- Requests that are rate limited don't count towards your rate limits.
Size Limits
In addition to limiting number of calls, a limit is also put on the max number of elements returned from our collection resources.
Unless other limits are specified in the API documentation the page size is
| Page Size | |
|---|---|
| Default page size | 20 |
| Max Page Size | 1000 |
Fair Use Policy
In summary
To uphold peak performance of all Trackunit APIs as well as webhooks and ensure a positive experience for all partners and customers, we strongly encourage developers to review and optimize their API calls and integration workflows. If an application or an integration creates an excessive load on our APIs, Trackunit is at liberty, without warning, to restrict the integration's access to our APIs. Additionally we monitor error rates on webhook endpoints and reserve the right to disable endpoints that continuously have excessive failure rates. We are happy to offer help and guidance on how to optimise your technical implementation.
Scope
This policy governs the use of Trackunit's APIs and webhooks by all users, including developers, businesses, and individuals.
Acceptable Use:
- Integrate our APIs and webhooks to enhance software or applications.
- Retrieve useful data using our APIs and webhooks.
- Develop and test software with our APIs and webhooks.
Unacceptable Use:
- Violation of laws or regulations.
- Copy, reproduce, or distribute our APIs or webhooks without consent.
- Use our APIs or webhooks for illegal, harmful, or malicious purposes.
- Attempt to reverse engineer or decompile our APIs or webhooks.
- Use our APIs or webhooks in ways that harm our services, infrastructure, or users.
- Collect personal data without appropriate consent.
- Resell or commercialize our APIs or webhooks.
Usage Limits
We may establish usage limits for our APIs, including limits on the number of requests per minute, day, or other time period. If you exceed these limits, we may take measures to ensure compliance with this Policy, including limiting or suspending your access to our APIs.
Enforcement
We reserve the right to take any action we deem necessary to enforce this Policy, including, but not limited to, limiting or suspending your access to our APIs and webhooks, terminating your account, or taking legal action.